foscam-ruby 0.0.3 → 0.1.0

data/lib/foscam/schedule/week.rb

@@ -0,0 +1,89 @@
+module Foscam
+	module Schedule
+		class Week
+			# attr_accessor :sunday, :monday, :tuesday, :wednesday, :thursday, :friday, :saturday
+			attr_accessor :days
+
+			##
+			# @param [Hash] params Each input is a 32-bit bitmask representing a an 8 hour period divided into 15 minute block. Three inputs are needed for each day to to represent a full 24 hour of 96-bits.
+			# @option params [Fixnum] :fri_0
+			# @option params [Fixnum] :fri_1
+			# @option params [Fixnum] :fri_2
+			# @option params [Fixnum] :mon_0
+			# @option params [Fixnum] :mon_1
+			# @option params [Fixnum] :mon_2
+			# @option params [Fixnum] :sat_0
+			# @option params [Fixnum] :sat_1
+			# @option params [Fixnum] :sat_2
+			# @option params [Fixnum] :sun_0
+			# @option params [Fixnum] :sun_1
+			# @option params [Fixnum] :sun_2
+			# @option params [Fixnum] :thu_0
+			# @option params [Fixnum] :thu_1
+			# @option params [Fixnum] :thu_2
+			# @option params [Fixnum] :tue_0
+			# @option params [Fixnum] :tue_1
+			# @option params [Fixnum] :tue_2
+			# @option params [Fixnum] :wed_0
+			# @option params [Fixnum] :wed_1
+			# @option params [Fixnum] :wed_2
+			def initialize(params = {})
+				self.days = {}
+				[:sunday, :monday, :tuesday, :wednesday, :thursday, :friday, :saturday].each do |day|
+					abbrev = day.to_s[0..2]
+					bit0 = params.has_key?("#{abbrev}_0".to_sym) ? params["#{abbrev}_0".to_sym] : 0
+					bit1 = params.has_key?("#{abbrev}_1".to_sym) ? params["#{abbrev}_1".to_sym] : 0
+					bit2 = params.has_key?("#{abbrev}_2".to_sym) ? params["#{abbrev}_2".to_sym] : 0
+					self.days.merge!( day => Day.new(bit0,bit1,bit2))
+				end
+			end
+
+			##
+			# Determine if the the schedule is true at the given date time
+			# @param time [Time, DateTime]
+			# @return [FalseClass, TrueClass] Whether the schedule is true at that time
+			def busy_at?(time)
+				time = time.to_time if time.is_a?(DateTime)
+				if time.sunday?
+					days[:sunday].busy_at?(time)
+				elsif time.monday?
+					days[:monday].busy_at?(time)
+				elsif time.tuesday?
+					days[:tuesday].busy_at?(time)
+				elsif time.wednesday?
+					days[:wednesday].busy_at?(time)
+				elsif time.thursday?
+					days[:thursday].busy_at?(time)
+				elsif time.friday?
+					days[:friday].busy_at?(time)
+				elsif time.saturday?
+					days[:saturday].busy_at?(time)
+				end
+			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.days.each do |name, day|
+					h.merge!(name => day.to_hash)
+				end
+				h
+			end
+			##
+			# Convert the Week to the form of the input hash
+			# @return [Hash]
+			def to_param
+				params = {}
+				self.days.each do |name, day|
+					abbrev = name.to_s[0..2]
+					day.bits.each_index do |i|
+						params.merge!("#{abbrev}_#{i}".to_sym => day.bits[i].bit)
+					end
+				end
+				params
+			end
+		end
+	end
+end

data/lib/foscam/version.rb

@@ -1,4 +1,4 @@
 module Foscam
 	# Gem Version number
-    VERSION = "0.0.3"
+    VERSION = "0.1.0"
 end

data/spec/foscam/client_spec.rb

@@ -410,23 +410,9 @@ describe Foscam::Client do
 					:mail_svr, :mail_port, :mail_tls, :mail_user, :mail_pwd, :mail_sender, 
 					:mail_receiver1, :mail_receiver2, :mail_receiver3, :mail_receiver4, :mail_inet_ip, 
 					:ftp_svr, :ftp_port, :ftp_user, :ftp_pwd, :ftp_dir, :ftp_mode, :ftp_upload_interval, :ftp_filename, :ftp_numberoffiles, :ftp_schedule_enable, 
-					:ftp_schedule_sun_0, :ftp_schedule_sun_1, :ftp_schedule_sun_2, 
-					:ftp_schedule_mon_0, :ftp_schedule_mon_1, :ftp_schedule_mon_2, 
-					:ftp_schedule_tue_0, :ftp_schedule_tue_1, :ftp_schedule_tue_2, 
-					:ftp_schedule_wed_0, :ftp_schedule_wed_1, :ftp_schedule_wed_2, 
-					:ftp_schedule_thu_0, :ftp_schedule_thu_1, :ftp_schedule_thu_2, 
-					:ftp_schedule_fri_0, :ftp_schedule_fri_1, :ftp_schedule_fri_2, 
-					:ftp_schedule_sat_0, :ftp_schedule_sat_1, :ftp_schedule_sat_2, 
-					:alarm_motion_armed, :alarm_motion_sensitivity, :alarm_motion_compensation, 
+					:ftp_schedule,:alarm_motion_armed, :alarm_motion_sensitivity, :alarm_motion_compensation, 
 					:alarm_input_armed, :alarm_ioin_level, :alarm_iolinkage, :alarm_preset, :alarm_ioout_level, :alarm_mail, :alarm_upload_interval, :alarm_http, :alarm_msn, :alarm_http_url, :alarm_schedule_enable, 
-					:alarm_schedule_sun_0, :alarm_schedule_sun_1, :alarm_schedule_sun_2, 
-					:alarm_schedule_mon_0, :alarm_schedule_mon_1, :alarm_schedule_mon_2, 
-					:alarm_schedule_tue_0, :alarm_schedule_tue_1, :alarm_schedule_tue_2, 
-					:alarm_schedule_wed_0, :alarm_schedule_wed_1, :alarm_schedule_wed_2, 
-					:alarm_schedule_thu_0, :alarm_schedule_thu_1, :alarm_schedule_thu_2, 
-					:alarm_schedule_fri_0, :alarm_schedule_fri_1, :alarm_schedule_fri_2, 
-					:alarm_schedule_sat_0, :alarm_schedule_sat_1, :alarm_schedule_sat_2, 
-					:decoder_baud, :msn_user, :msn_pwd, 
+					:alarm_schedule,:decoder_baud, :msn_user, :msn_pwd, 
 					:msn_friend1, :msn_friend2, :msn_friend3, :msn_friend4, :msn_friend5, :msn_friend6, :msn_friend7, :msn_friend8, :msn_friend9, :msn_friend10
 				].each do |key|
 					response.should have_key(key) 
@@ -484,34 +470,14 @@ describe Foscam::Client do
 				response[:ftp_schedule_enable].should be_a_kind_of(Boolean)
 			end
 
-			it "sets the ftp_schedule as an integer" do
+			it "sets the ftp_schedule as an Week" do
 				response = @service.get_params
-				[	
-					:ftp_schedule_sun_0, :ftp_schedule_sun_1, :ftp_schedule_sun_2, 
-					:ftp_schedule_mon_0, :ftp_schedule_mon_1, :ftp_schedule_mon_2, 
-					:ftp_schedule_tue_0, :ftp_schedule_tue_1, :ftp_schedule_tue_2, 
-					:ftp_schedule_wed_0, :ftp_schedule_wed_1, :ftp_schedule_wed_2, 
-					:ftp_schedule_thu_0, :ftp_schedule_thu_1, :ftp_schedule_thu_2, 
-					:ftp_schedule_fri_0, :ftp_schedule_fri_1, :ftp_schedule_fri_2, 
-					:ftp_schedule_sat_0, :ftp_schedule_sat_1, :ftp_schedule_sat_2
-				].each do |key|
-					response[key].should be_a_kind_of(Integer)
-				end
+				response[:ftp_schedule].should be_an_instance_of(Foscam::Schedule::Week)
 			end
 
-			it "sets the alarm_schedule as an integer" do
+			it "sets the alarm_schedule as an Week" do
 				response = @service.get_params
-				[	
-					:alarm_schedule_sun_0, :alarm_schedule_sun_1, :alarm_schedule_sun_2, 
-					:alarm_schedule_mon_0, :alarm_schedule_mon_1, :alarm_schedule_mon_2, 
-					:alarm_schedule_tue_0, :alarm_schedule_tue_1, :alarm_schedule_tue_2, 
-					:alarm_schedule_wed_0, :alarm_schedule_wed_1, :alarm_schedule_wed_2, 
-					:alarm_schedule_thu_0, :alarm_schedule_thu_1, :alarm_schedule_thu_2, 
-					:alarm_schedule_fri_0, :alarm_schedule_fri_1, :alarm_schedule_fri_2, 
-					:alarm_schedule_sat_0, :alarm_schedule_sat_1, :alarm_schedule_sat_2
-				].each do |key|
-					response[key].should be_a_kind_of(Integer)
-				end
+				response[:alarm_schedule].should be_an_instance_of(Foscam::Schedule::Week)
 			end
 		end
 
@@ -1028,15 +994,16 @@ describe Foscam::Client do
 			end
 			it "returns a hash of variables" do
 				params = {
-					:schedule_sun_0 => 95, :schedule_sun_1 => 45, :schedule_sun_2 => 20,
-					:schedule_mon_0 => 95, :schedule_mon_1 => 45, :schedule_mon_2 => 20,
-					:schedule_tue_0 => 95, :schedule_tue_1 => 45, :schedule_tue_2 => 20,
-					:schedule_wed_0 => 95, :schedule_wed_1 => 45, :schedule_wed_2 => 20,
-					:schedule_thu_0 => 95, :schedule_thu_1 => 45, :schedule_thu_2 => 20,
-					:schedule_fri_0 => 95, :schedule_fri_1 => 45, :schedule_fri_2 => 20,
-					:schedule_sat_0 => 95, :schedule_sat_1 => 45, :schedule_sat_2 => 20
+					:sun_0 => 95, :sun_1 => 45, :sun_2 => 20,
+					:mon_0 => 95, :mon_1 => 45, :mon_2 => 20,
+					:tue_0 => 95, :tue_1 => 45, :tue_2 => 20,
+					:wed_0 => 95, :wed_1 => 45, :wed_2 => 20,
+					:thu_0 => 95, :thu_1 => 45, :thu_2 => 20,
+					:fri_0 => 95, :fri_1 => 45, :fri_2 => 20,
+					:sat_0 => 95, :sat_1 => 45, :sat_2 => 20
 				}
-				response = @service.set_forbidden(params)
+				week = Foscam::Schedule::Week.new(params)
+				response = @service.set_forbidden(week)
 				response.should be_true
 			end
 		end
@@ -1063,18 +1030,9 @@ describe Foscam::Client do
 					spec.run
 				end
 			end
-			it "returns a hash of variables" do
+			it "returns an Week" do
 				response = @service.get_forbidden
-				[	:schedule_sun_0, :schedule_sun_1, :schedule_sun_2,
-					:schedule_mon_0, :schedule_mon_1, :schedule_mon_2,
-					:schedule_tue_0, :schedule_tue_1, :schedule_tue_2,
-					:schedule_wed_0, :schedule_wed_1, :schedule_wed_2,
-					:schedule_thu_0, :schedule_thu_1, :schedule_thu_2,
-					:schedule_fri_0, :schedule_fri_1, :schedule_fri_2,
-					:schedule_sat_0, :schedule_sat_1, :schedule_sat_2
-				].each do |key|
-					response.should have_key(key) 
-				end
+				response.should be_an_instance_of(Foscam::Schedule::Week)
 			end
 		end
 
@@ -1087,7 +1045,7 @@ describe Foscam::Client do
 			end
 			it "returns a hash of variables" do
 				response = @service.get_forbidden
-				response.should == {}
+				response.should be_nil
 			end
 		end
 	end

data/spec/foscam/model/alarm_config_spec.rb

@@ -0,0 +1,164 @@
+require 'spec_helper'
+
+describe Foscam::Model::AlarmConfig do
+
+	def valid_client_params
+		{:url => "http://192.168.0.1/", :username => "foobar", :password => "secret"}
+	end
+
+	def default_get_params
+		{
+        	:alarm_motion_armed => true,
+        	:alarm_motion_sensitivity => 0,
+        	:alarm_motion_compensation => 0,
+        	:alarm_input_armed => true,
+        	:alarm_ioin_level => 1,
+        	:alarm_iolinkage => 0,
+        	:alarm_preset => 0,
+        	:alarm_ioout_level => 1,
+        	:alarm_mail => false,
+        	:alarm_upload_interval => 2,
+        	:alarm_http => false,
+        	:alarm_msn => false,
+        	:alarm_http_url => '',
+        	:alarm_schedule_enable => true,
+        	:alarm_schedule => Foscam::Schedule::Week.new
+		}
+	end
+
+	before(:each) do
+		@client = ::Foscam::Client.new(valid_client_params)
+		@client.stub(:get_params).and_return(default_get_params)
+	end
+
+
+	describe "#client=" do
+		before(:each) do
+			@alarm = Foscam::Model::AlarmConfig.instance
+		end
+		it "sets the current Foscam::Client" do
+			@alarm.client = @client
+			@alarm.client.should eql(@client)
+		end
+
+		it "sets the alarm parameters" do
+			@alarm.client = @client
+			@alarm.motion_armed.should == default_get_params[:alarm_motion_armed]
+			@alarm.motion_sensitivity.should == default_get_params[:alarm_motion_sensitivity]
+			@alarm.motion_compensation.should == default_get_params[:alarm_motion_compensation]
+			@alarm.input_armed.should == default_get_params[:alarm_input_armed]
+			@alarm.ioin_level.should == default_get_params[:alarm_ioin_level]
+			@alarm.iolinkage.should == default_get_params[:alarm_iolinkage]
+			@alarm.preset.should == default_get_params[:alarm_preset]
+			@alarm.ioout_level.should == default_get_params[:alarm_ioout_level]
+			@alarm.mail.should == default_get_params[:alarm_mail]
+			@alarm.http.should == default_get_params[:alarm_http]
+			@alarm.msn.should == default_get_params[:alarm_msn]
+			@alarm.http_url.should == default_get_params[:alarm_http_url]
+			@alarm.schedule_enable.should == default_get_params[:alarm_schedule_enable]
+		end
+	end
+
+	describe "#save" do
+		before(:each) do
+			# @client.stub(:get_params).and_return(one_device_response)
+			@alarm = Foscam::Model::AlarmConfig.instance
+		end
+		context "with valid params" do
+			before(:each) do 
+				@alarm.stub(:is_valid?).and_return(true)
+			end
+			context "is dirty" do
+				context "request is successful" do
+					before(:each) do
+						params = {
+							:motion_armed => false,
+							:motion_sensitivity => 10,
+							:motion_compensation => 20,
+							:input_armed => false,
+							:ioin_level=>1, :iolinkage=>0, :preset=>0, :ioout_level=>1,
+							:mail => true,							
+							:http => true,
+							:msn => true,
+							# :http_url => "http://mydomain.com/",
+							:schedule_enable => false
+						}
+						# @alarm.stub(:changed?).and_return(true)
+						@client.should_receive(:set_alarm).with(params).once
+						@client.stub(:set_alarm).and_return(true)
+					end
+					it "updates the alarm attributes that changed" do
+						@alarm.client = @client
+						@alarm.motion_armed = false
+						@alarm.motion_sensitivity = 10
+						@alarm.motion_compensation = 20
+						@alarm.input_armed = false
+						@alarm.mail = true
+						@alarm.http = true
+						@alarm.msn = true
+						# @alarm.http_url = "http://mydomain.com/",
+						@alarm.schedule_enable = false
+						flag = @alarm.save
+						flag.should be_true
+					end
+				end
+				context "request is unsuccessful" do
+					before(:each) do
+						params = {
+							:motion_armed => false,
+							:motion_sensitivity => 10,
+							:motion_compensation => 20,
+							:input_armed => false,
+							:mail => true,
+							# :upload_interval => 5,
+							:http => true,
+							:msn => true,
+							# :http_url => "http://mydomain.com/",
+							:schedule_enable => false
+						}
+						# @alarm.stub(:changed?).and_return(true)
+						@client.should_receive(:set_alarm).with(params).once
+						@client.stub(:set_alarm).and_return(false)
+					end
+					it "fails to update the device attributes" do
+						@alarm.client = @client
+						@alarm.motion_armed = false
+						@alarm.motion_sensitivity = 10
+						@alarm.motion_compensation = 20
+						@alarm.input_armed = false
+						@alarm.mail = true
+						@alarm.http = true
+						@alarm.msn = true
+						@alarm.http_url = "http://mydomain.com/",
+						@alarm.schedule_enable = false
+
+						flag = @alarm.save
+						flag.should be_false
+					end
+				end
+			end
+			context "is not dirty" do
+				before(:each) do
+					@alarm.stub(:changed?).and_return(false)						
+				end
+				it "skips updating since nothing changed" do
+					@client.should_not_receive(:set_alarm)
+					@alarm.client = @client
+					flag = @alarm.save
+					flag.should be_false
+				end
+			end
+		end
+		context "with invalid params" do
+			before(:each) do
+				@alarm.stub(:is_valid?).and_return(false)
+			end
+			it "skips updating since nothing changed" do
+				@client.should_not_receive(:set_alarm)
+				@alarm.client = @client
+				flag = @alarm.save
+				flag.should be_false
+			end
+		end
+	end
+end

data/spec/foscam/model/base_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Foscam::Model::Base do
+
+	def valid_params
+		{:url => "http://192.168.0.1/", :username => "foobar", :password => "secret"}
+	end
+
+	describe "#connect" do
+		before(:each) do
+			# @client.stub(:get_params).and_return(one_device_response)
+			@device = Foscam::Model::Base.new
+		end
+		it "returns an instance of a Foscam::Client" do
+			client = @device.connect(valid_params)
+			client.should be_an_instance_of(::Foscam::Client)
+			client.username.should == valid_params[:username]
+			client.url.should == valid_params[:url]
+			client.password.should == valid_params[:password]
+		end
+	end
+end

data/spec/foscam/model/device_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+describe Foscam::Model::Device do
+
+	def valid_params
+		{:url => "http://192.168.0.1/", :username => "foobar", :password => "secret"}
+	end
+	before(:each) do
+		@client = ::Foscam::Client.new(valid_params)
+		@client.stub(:get_camera_params).and_return({:resolution => "qvga", :brightness => 169, :contrast => 2, :mode => "60hz", :flip => "flip", :fps => 0})
+	end
+
+	describe "#client=" do
+		before(:each) do
+			@device = Foscam::Model::Device.instance
+		end
+		it "sets the current Foscam::Client" do
+			@device.client = @client
+			@device.client.should eql(@client)
+		end
+
+		it "sets the camera parameters" do
+			@device.client = @client
+			@device.resolution.should == "qvga"
+			@device.brightness.should == 169
+			@device.contrast.should == 2
+			# @device.mode.should == "60Hz"
+			# @device.orientation.should == "default"
+		end
+	end
+
+	describe "#capture" do
+		before(:each) do
+			# @client.stub(:get_params).and_return(one_device_response)
+			@device = Foscam::Model::Device.instance
+		end
+		context "request is successful" do
+			it "returns an image" do
+				@client.should_receive(:snapshot)
+				@device.client = @client
+				image = @device.capture
+			end
+		end
+	end
+
+
+				# def action(value)
+				# 	# have an action map to map some subset to the foscam set
+				# 	@client.decoder_control(value)
+				# end
+	describe "#action" do
+		before(:each) do
+			# @client.stub(:get_params).and_return(one_device_response)
+			@device = Foscam::Model::Device.instance
+		end
+		context "request is successful" do
+			before(:each) do
+				@client.stub(:decoder_control).and_return(true)
+			end
+			it "processes the action" do
+				@client.should_receive(:decoder_control).with(:up).once
+				@device.client = @client
+				flag = @device.action(:up)
+				flag.should be_true
+			end
+		end
+	end
+
+	describe "#save" do
+		before(:each) do
+			# @client.stub(:get_params).and_return(one_device_response)
+			@device = Foscam::Model::Device.instance
+		end
+		context "with valid params" do
+			before(:each) do 
+				@device.stub(:is_valid?).and_return(true)
+			end
+			context "is dirty" do
+				before(:each) do
+					params = {:resolution => "vga", :brightness => 230, :contrast => 3}
+					# @device.stub(:changed?).and_return(true)
+					@client.should_receive(:camera_control).with(params).once
+				end
+				context "request is successful" do
+					before(:each) do
+						@client.stub(:camera_control).and_return(true)
+					end
+					it "updates the device attributes that changed" do
+						@device.client = @client
+						@device.brightness = 230
+						@device.contrast = 3
+						@device.resolution = "vga"
+						flag = @device.save
+						flag.should be_true
+					end
+				end
+				context "request is unsuccessful" do
+					before(:each) do
+						@client.stub(:camera_control).and_return(false)
+					end
+					it "fails to update the device attributes" do
+						@device.client = @client
+						@device.brightness = 230
+						@device.contrast = 3
+						@device.resolution = "vga"
+						flag = @device.save
+						flag.should be_false
+					end
+				end
+			end
+			context "is not dirty" do
+				before(:each) do
+					@device.stub(:changed?).and_return(false)						
+				end
+				it "skips updating since nothing changed" do
+					@client.should_not_receive(:camera_control)
+					@device.client = @client
+					flag = @device.save
+					flag.should be_false
+				end
+			end
+		end
+		context "with invalid params" do
+			before(:each) do
+				@device.stub(:is_valid?).and_return(false)
+			end
+			it "skips updating since nothing changed" do
+				@client.should_not_receive(:camera_control)
+				@device.client = @client
+				flag = @device.save
+				flag.should be_false
+			end
+		end
+	end
+
+end