foscam-ruby 0.0.3 → 0.1.0

data/lib/foscam/model/mail_server.rb

@@ -0,0 +1,124 @@
+module Foscam
+	module Model
+		class MailServer < Base
+
+			include Singleton
+
+			class Recipient
+
+				include Singleton
+				include ::ActiveModel::Dirty
+				include ::ActiveModel::Validations
+				include ::ActiveModel::Conversion
+				extend ::ActiveModel::Naming
+				extend ::ActiveModel::Translation
+
+
+				attr_accessor :id
+
+				attr_reader :address
+
+				define_attribute_methods [:address]
+
+				def initialize(params = nil)
+					params.each do |attr, value|
+						self.public_send("#{attr}=", value)
+					end if params
+				end
+
+				def address=(val)
+					address_will_change! unless val == @address
+					@address = val
+				end
+
+			end
+
+			define_model_callbacks :save, :clear
+
+			attr_reader :username, :password, :address, :port, :sender, :recipients
+
+
+			def sender=(val)
+				sender_will_change! unless val == @sender
+				@sender = val
+			end
+
+			def username=(val)
+				username_will_change! unless val == @username
+				@username = val
+			end
+
+			def password=(val)
+				password_will_change! unless val == @password
+				@password = val
+			end
+
+			def address=(val)
+				address_will_change! unless val == @address
+				@address = val
+			end
+
+			def port=(val)
+				port_will_change! unless val == @port
+				@port = val
+			end
+
+			def client=(obj)
+				unless obj.nil?
+					MailServer::client = obj
+					params = client.get_params
+					unless params.empty?
+						self.sender = params[:mail_sender]
+						self.address = params[:mail_svr]
+						self.port = params[:mail_port]
+						self.username = params[:mail_user]
+						self.password = params[:mail_pwd]
+						@recipients = []
+						(1..4).each do |i|
+							@recipients << Recipient.new(:id => i, :address => params["mail_receiver#{i}".to_sym]) if params.has_key?("mail_receiver#{i}".to_sym) && !params["mail_receiver#{i}".to_sym].empty?
+						end
+					end
+				end
+			end
+
+			define_attribute_methods [:username, :password, :address, :port, :sender]
+
+			def save
+				run_callbacks :save do
+					flag = false
+					if changed? && is_valid?
+						@previously_changed = changes
+						flag = client.set_mail(dirty_params_hash)
+						@changed_attributes.clear if flag
+					end
+					flag
+				end
+			end
+
+			def clear
+				run_callbacks :clear do
+					flag = false
+					params = {:sender => "", :user => "", :pwd => "", :svr => "", :port => 21, :receiver1 => "", :receiver2 => "", :receiver3 => "", :receiver4 => ""}
+					flag = client.set_mail(params)
+					@changed_attributes.clear if flag
+					flag
+				end
+			end
+
+			private
+
+			def dirty_params_hash
+				h = {}
+				h.merge!({:sender => self.sender}) if sender_changed?
+				h.merge!({:user => self.username}) if username_changed?
+				h.merge!({:pwd => self.password}) if password_changed?
+				h.merge!({:svr => self.address}) if address_changed?
+				h.merge!({:port => self.port}) if port_changed?
+				self.recipients.each do |recipient|
+					h.merge!({"receiver#{recipient.id}".to_sym => recipient.address}) if recipient.address_changed?
+				end
+				h
+			end
+		end
+	end
+end

data/lib/foscam/model/network.rb

@@ -0,0 +1,79 @@
+module Foscam
+	module Model
+		class Network < Base
+			
+			include Singleton
+
+	        attr_reader :ip_address, :mask, :gateway, :dns, :port
+
+	        define_model_callbacks :save
+
+
+	        def ip_address=(val)
+				ip_address_will_change! unless val == @ip_address
+				@ip_address = val
+			end
+
+			def mask=(val)
+				mask_will_change! unless val == @mask
+				@mask = val
+			end
+
+			def gateway=(val)
+				gateway_will_change! unless val == @gateway
+				@gateway = val
+			end
+
+			def dns=(val)
+				dns_will_change! unless val == @dns
+				@dns = val
+			end
+
+			def port=(val)
+				port_will_change! unless val == @port
+				@port = val
+			end
+
+			def client=(obj)
+				unless obj.nil?
+					Network::client = obj
+					params = client.get_params
+					unless params.empty?
+						self.ip_address = params[:ip]
+						self.mask = params[:mask]
+						self.gateway = params[:gateway]
+						self.dns = params[:dns]
+						self.port = params[:port]
+					end
+				end
+			end
+
+			define_attribute_methods [:ip_address, :mask, :gateway, :dns, :port]
+
+			def save
+				run_callbacks :save do
+					flag = false
+					if changed? && is_valid?
+						@previously_changed = changes
+						flag = client.set_network(dirty_params_hash)
+						@changed_attributes.clear if flag
+					end
+					flag
+				end
+			end
+
+			private
+
+			def dirty_params_hash
+				h = {}
+				h.merge!({:ip 		=> self.ip_address }) if ip_address_changed?
+				h.merge!({:mask 	=> self.mask }) if mask_changed?
+				h.merge!({:gateway 	=> self.gateway }) if gateway_changed?
+				h.merge!({:dns 		=> self.dns }) if dns_changed?
+				h.merge!({:port 	=> self.port }) if port_changed?
+				h
+			end
+
+		end
+	end
+end

data/lib/foscam/model/user.rb

@@ -0,0 +1,174 @@
+module Foscam
+	module Model
+		class User < Base
+			
+			# Max number of users supported by foscam
+			MAX_NUMBER = 8
+
+			# :nodoc
+			define_model_callbacks :save, :create, :destroy
+			
+			##
+			# @!attribute [r] id
+			#   @return [Fixnum] The id of the user
+			attr_reader :id
+
+			##
+			# @!attribute [rw] username
+			#   @return [String] The name of the user
+			attr_reader :username
+
+			##
+			# @!attribute [rw] password
+			#   @return [String] The password of the user
+			attr_reader :password
+
+			##
+			# @!attribute [rw] privilege
+			#   @return [Symbol] The privilege of the user
+			attr_reader :privilege
+
+			define_attribute_methods [:username, :password, :privilege]
+
+
+			def username=(val)
+				username_will_change! unless val == @username
+				@username = val
+			end
+
+			def password=(val)
+				password_will_change! unless val == @password
+				@password = val
+			end
+
+			def privilege=(val)
+				privilege_will_change! unless val == @privilege
+				@privilege = val
+			end
+
+			##
+			# Get all the users
+			# @return [Array] of Users
+			def self.all
+				cam_params = client.get_params
+				users = []
+				unless cam_params.empty?
+					(1..8).each do |i|
+						unless cam_params["user#{i}_name".to_sym].empty?
+							user = User.new(:username => cam_params["user#{i}_name".to_sym], :password => cam_params["user#{i}_pwd".to_sym], :privilege => cam_params["user#{i}_pri".to_sym])
+							user.instance_variable_set(:@id, i)
+							users << user
+						end
+					end
+				end
+				users
+			end
+
+			##
+			# Create a user with the specified parameters
+			# @param params [Hash] User attributes
+			# @option params [String] :username
+			# @option params [String] :password
+			# @option params [Symbol] :privilege
+			# @return [User, nil] Returns the user if successfully saved
+			def self.create(params ={})
+				user = User.new(params)
+				user.save ? user : nil
+			end
+
+
+			##
+			# Find a specific user by name
+			# @param id [Fixnum] The id of the user
+			# @return [User]
+			def self.find(id)
+				user = nil
+				if id > 0 && id <= MAX_NUMBER
+					cam_params = client.get_params
+					if !cam_params.empty? && !cam_params["user#{id}_name".to_sym].empty?
+						user = User.new(:username => cam_params["user#{id}_name".to_sym], :password => cam_params["user#{id}_pwd".to_sym], :privilege => cam_params["user#{id}_pri".to_sym])
+						user.instance_variable_set(:@id, id)
+					end
+				end
+				user
+			end
+
+			##
+			# Delete a user by the id
+			# @param id [Fixnum] The id of the user
+			# @return [FalseClass, TrueClass] Whether or not the user was successfully deleted
+			def self.delete(id)
+				params = {"user#{id}".to_sym => "", "pwd#{id}".to_sym => "", "pri#{id}".to_sym => 0}
+				id > 0 && id <= MAX_NUMBER ? client.set_users(params) : false
+			end
+
+
+			##
+			# Save the current user to the camera
+			# @return [FalseClass, TrueClass] Whether or not the user was successfully saved
+			def save
+				run_callbacks :save do
+					flag = false
+					if changed? && is_valid? && set_id
+						@previously_changed = changes
+						# Get the first user that is not taken
+						flag = client.set_users(dirty_params_hash)
+						@changed_attributes.clear if flag
+					end
+					flag
+				end
+			end
+
+			##
+			# Check for User equality
+			# @param other [User]
+			# @return [FalseClass, TrueClass] Whether or not the users are the same
+			def ==(other)
+				other.equal?(self) || ( other.instance_of?(self.class) && other.id == @id && !other.id.nil? && !@id.nil?)
+			end
+
+			##
+			# Delete the current user
+			# @return [FalseClass, TrueClass] Whether or not the user was successfully deleted
+			def destroy
+				run_callbacks :destroy do
+					self.username = ""
+					self.password = ""
+					self.privilege = 0
+					flag = @id.nil? ? false : client.set_users(dirty_params_hash)
+					@changed_attributes.clear
+					flag
+				end
+			end
+
+			private
+
+			def dirty_params_hash
+				h = {}
+				h.merge!({"user#{@id}".to_sym => @username}) if username_changed?
+				h.merge!({"pwd#{@id}".to_sym => @password}) if password_changed?
+				h.merge!({"pri#{@id}".to_sym => @privilege}) if privilege_changed?
+				h
+			end
+
+			def set_id
+				flag = false
+				if @id.nil?
+					cam_params = client.get_params
+					unless cam_params.empty?
+						(1..8).each do |i|
+							if cam_params["user#{i}_name".to_sym].empty?
+								@id = i
+								flag = true
+								break
+							end
+						end
+					end
+				else
+					flag = true
+				end
+				flag
+			end
+		end
+	end
+end

data/lib/foscam/schedule/day.rb

@@ -0,0 +1,63 @@
+module Foscam
+	module Schedule
+		class Day
+
+			##
+			# @param bit1 [Fixnum] The 32-bit bitmask representing the first third of the day
+			# @param bit2 [Fixnum] The 32-bit bitmask representing the second third of the day
+			# @param bit3 [Fixnum] The 32-bit bitmask representing the last third of the day
+			def initialize(bit1, bit2, bit3)
+				self.bits = Array.new(3)
+				self.bits[0] = ThirdOfADay.new(bit1)
+				self.bits[1] = ThirdOfADay.new(bit2)
+				self.bits[2] = ThirdOfADay.new(bit3)
+			end
+			
+			attr_accessor :bits
+
+			##
+			# Determine if the the schedule is true at the given date time
+			# @param time [Time, Fixnum, DateTime] Accepts multiple forms of time. If a Datetime or Time is used then only the time of day is used. If a fixnum is given then it is a number representing the number of seconds from the start of the day.
+			# @return [FalseClass, TrueClass] Whether it is busy at that time
+			def busy_at?(time)
+				case time
+				when Fixnum
+					bit = seconds/28800
+					bit_num = bit_from_time(seconds/3600, seconds % 3600)
+				when DateTime
+					time = time.to_time
+					bit = time.hour / 8
+					bit_num = bit_from_time(time.hour, time.min)
+				when Time
+					bit = time.hour / 8
+					bit_num = bit_from_time(time.hour, time.min)
+				else
+
+				end
+				self.bits[bit].active?(bit_num)
+			end
+
+			##
+			# Convert the Week to a nested hash with the day of the week as the key and and time as the second key
+			# @return [Hash]
+			def to_hash
+				h = {}
+				self.bits.each_index do |idx|
+					bits[idx].to_hash.each do |j, value|
+						minute = (j % 4) * 15
+						hour = j / 4 + idx * 8
+						h.merge!("#{"%02d" % hour}:#{"%02d" % minute}" => value)
+					end
+				end
+				h
+			end
+
+			# takes three integers
+			private
+
+			def bit_from_time(hours, minutes)
+				(hours % 8)*4 + minutes/15
+			end
+		end
+	end
+end

data/lib/foscam/schedule/third_of_a_day.rb

@@ -0,0 +1,42 @@
+
+module Foscam
+	module Schedule
+		class ThirdOfADay
+
+			attr_accessor :bit
+			
+			##
+			# @param bit [Fixnum] The 32-bit bitmask representing 8 hours divided into 15 minute blocks
+			def initialize(bit)
+				self.bit = bit
+			end
+
+			##
+			# Returns whether the bit is positive or not
+			# @param idx [Fixnum] The bit index representing the 15 minute block
+			# @return [FalseClass, TrueClass] Whether the bit is equal to 1
+			def active?(idx)
+				binary_string[31-idx].to_i > 0
+			end
+
+			##
+			# Convert the bitmask representing a third of a day with a Hash. The key is the idx of the bit and the value is a boolean of whether it is active or not
+			# @return [Hash]
+			def to_hash
+				h = {}
+				i = 0
+				binary_string.reverse.each_char do |char|
+					h.merge!({i => char.to_i > 0})
+					i = i + 1
+				end
+				h
+			end
+
+			private
+
+			def binary_string
+				@str ||= ("%032d" % self.bit.to_s(2))
+			end
+		end
+	end
+end