foscam-ruby 0.0.3 → 0.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NTM1YTU4NzIxZDQ1OTVhM2M5NWRhMDczZmFmY2ZlNDJkMjlkM2Q4Zg==
-  data.tar.gz: !binary |-
-    MGRiZTRmZWQyZDk2ODg1YWJlOTVhZTBiNGU5ZjQ5MWUyZjc2Yjg0NQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZTIzN2ZiYTFhODg4NzE0YjZiNGU2MjQ2ODljNTNjNTQ1ZjdkYTUyY2RhNmJj
-    YzQyOWZmNjcyZjU4MjkwZGEyYmNkYWNjOTUxY2I3ODk2YTM2NjU4ZGIyYmE5
-    NWNhZGRjZDQ5YmM1N2Y1NWIzYmY3YmEzZjNiZmExYjdjZDQ5ZWU=
-  data.tar.gz: !binary |-
-    M2UxMTgxNmVlNTgyMzM3YWYwYzIxYzRhNTJlYTQ5MTA4MWQ5ZWNkZmVjYTZj
-    MjlmZTJlMzU1OGFkYmI4ZmNiMmVkNThkYjdlNmY0Y2Q3NmZlMTBiNTMyMDBk
-    ZGU3MWE3NjdiM2RkZjhkNmMyN2E0Yzc5MDgyZWU2NmVkY2VlNmE=
+SHA1:
+  metadata.gz: 07206c44423faf623a2bf523367d0e07ebd87456
+  data.tar.gz: f035164cea711af91542b19fd2cbf2c559c1fadc
+SHA512:
+  metadata.gz: 683e4c6829e42cdca0ff3bab2c89022f921d6f9f572a1b310fdd1beaf2dfd503e96bfc0679a2327672f7999ae8c214b333f71b3972a671e722bce0e9d5dc319d
+  data.tar.gz: 2d0c567f0c6e0b8f20042d96abffc3e8c47a85065e9edabc98673e8bd90b108636732eee9c54b4bd46329678843e047300372aeee8a79df09491f1f5f943d644

data/.travis.yml

@@ -3,4 +3,4 @@ before_install:
 language: ruby
 rvm:
  - 1.9.3
- - 1.8.7
+ - 2.0.0

data/foscam-ruby.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday'
   spec.add_dependency 'mini_magick'
   spec.add_dependency 'active_support'
+  spec.add_dependency 'activemodel'
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/foscam-ruby.rb

@@ -2,8 +2,28 @@ require "foscam/version"
 require "faraday"
 require "mini_magick"
 require "active_support/core_ext/object/to_query"
+require "active_support/core_ext/class/attribute_accessors"
 require "date"
+require "date"
+require "active_model"
+require 'singleton'
+
+require 'foscam/model/base'
 
 module Foscam
 	autoload :Client, 'foscam/client'
+	module Model
+		autoload :User, 		'foscam/model/user'
+		autoload :Device, 		'foscam/model/device'
+		autoload :FtpServer, 	'foscam/model/ftp_server'
+		autoload :MailServer,	'foscam/model/mail_server'
+		autoload :AlarmConfig,	'foscam/model/alarm_config'
+		autoload :Network,		'foscam/model/network'
+	end
+
+	module Schedule
+		autoload :Week,		 	'foscam/schedule/week'
+		autoload :Day,	 		'foscam/schedule/day'
+		autoload :ThirdOfADay,	'foscam/schedule/third_of_a_day'
+	end
 end

data/lib/foscam/client.rb

@@ -1,145 +1,6 @@
+require "foscam/constants"
 module Foscam
 
-	# DDNS_STATUS
-	DDNS_STATUS = {
-		0 => "No Action",
-		1 => "It's connecting...",
-		2 => "Can't connect to the Server",
-		3 => "Dyndns Succeed",
-		4 => "DynDns Failed: Dyndns.org Server Error",
-		5 => "DynDns Failed: Incorrect User or Password",
-		6 => "DynDns Failed: Need Credited User",
-		7 => "DynDns Failed: Illegal Host Format",
-		8 => "DynDns Failed: The Host Does not Exist",
-		9 => "DynDns Failed: The Host Does not Belong to You",
-		10 => "DynDns Failed: Too Many or Too Few Hosts",
-		11 => "DynDns Failed: The Host is Blocked for Abusing",
-		12 => "DynDns Failed: Bad Reply from Server",
-		13 => "DynDns Failed: Bad Reply from Server",
-		14 => "Oray Failed: Bad Reply from Server",
-		15 => "Oray Failed: Incorrect User or Password",
-		16 => "Oray Failed: Incorrect Hostname",
-		17 => "Oray Succeed"
-	}
-
-	# UPNP_STATUS
-	UPNP_STATUS = {
-		0 => "No Action",
-		1 => "Succeed",
-		2 => "Device System Error",
-		3 => "Errors in Network Communication",
-		4 => "Errors in Chat with UPnP Device",
-		5 => "Rejected by UPnP Device, Maybe Port Conflict"
-	}
-
-	# ALARM_STATUS
-	ALARM_STATUS = {
-		0 => "No alarm",
-		1 => "Motion alarm",
-		2 => "Input Alarm"
-	}
-
-	# CAMERA_PARAMS_MODE
-	CAMERA_PARAMS_MODE = {
-		0 => "50hz",
-		1 => "60hz",
-		2 => "outdoor"
-	}
-
-	# CAMERA_CONTROL_MODE
-	CAMERA_CONTROL_MODE = CAMERA_PARAMS_MODE.inject({}){|memo,(k,v)| memo[v.to_sym] = k; memo}
-
-	# CAMERA_PARAMS_ORIENTATION
-	CAMERA_PARAMS_ORIENTATION = {
-		0 => "default",
-		1 => "flip",
-		2 => "mirror",
-		3 => "flip+mirror"
-	}
-
-	# CAMERA_CONTROL_ORIENTATION
-	CAMERA_CONTROL_ORIENTATION = CAMERA_PARAMS_ORIENTATION.inject({}){|memo,(k,v)| memo[v.to_sym] = k; memo}
-
-	# CAMERA_PARAMS_RESOLUTION
-	CAMERA_PARAMS_RESOLUTION = {
-		8 => "qvga",
-		32 => "vga"
-	}
-
-	# CAMERA_CONTROL_RESOLUTION
-	CAMERA_CONTROL_RESOLUTION = CAMERA_PARAMS_RESOLUTION.inject({}){|memo,(k,v)| memo[v.to_sym] = k; memo}
-
-	# CAMERA_CONTROLS
-	CAMERA_CONTROLS = {
-		:resolution => 0,
-		:brightness => 1,
-		:contrast 	=> 2,
-		:mode 		=> 3,
-		:flip 		=> 5
-	}
-
-	# DECODER_CONTROLS
-	DECODER_CONTROLS = {
-		:up  => 0,
-		:stop => 1,
-		:stop_up => 1,
-		:down => 2,
-		:stop_down => 3,
-		:left => 4,
-		:stop_left => 5,
-		:right => 6,
-		:stop_right => 7,
-		:center => 25,
-		:vertical_patrol => 26,
-		:stop_vertical_patrol => 27,
-		:horizon_patrol => 28,
-		:stop_horizon_patrol => 29,
-		:io_output_high => 94,
-		:io_output_low => 95,
-	}
-
-	# USER_PERMISSIONS
-	USER_PERMISSIONS = {
-		0 => :visitor,
-		1 => :operator,
-		2 => :administrator
-	}
-
-	# PTZ_AUTO_PATROL_TYPE
-	PTZ_AUTO_PATROL_TYPE = {
-		0 => :none,
-		1 => :horizontal,
-		2 => :vertical,
-		3 => :"horizontal+vertical"
-	}
-
-	# PTZ_AUTO_PATROL_TYPE_ID
-	PTZ_AUTO_PATROL_TYPE_ID = PTZ_AUTO_PATROL_TYPE.invert
-
-	# LED_MODE
-	LED_MODE = {
-		0 => :mode1,
-		1 => :mode2,
-		2 => :disabled
-	}
-
-	# LED_MODE_ID
-	LED_MODE_ID = LED_MODE.invert
-	
-	# DECODER_BAUD
-	DECODER_BAUD = {
-		9 => :B1200,
-		11 => :B2400,
-		12 => :B4800,
-		13 => :B9600,
-		14 => :B19200,
-		15 => :B38400,
-		4097 => :B57600,
-		4098 => :B115200
-	}
-	# DECODER_BAUD_ID
-	DECODER_BAUD_ID = DECODER_BAUD.invert
-
 	# TODO: put in some documentation for this class
 	class Client
 
@@ -167,7 +28,6 @@ module Foscam
 
 		##
 		# Connects to the foscam webcam
-
 		# @param url [String] The address to your camera
 		# @param username [String] username to authorize with the camera
 		# @param password [String] password to authorize with the camera
@@ -342,7 +202,7 @@ module Foscam
 		# @return [Hash] If the request is unsuccessful the hash will be empty. Otherwise it contains the following fields:
 		# 	* :id (String) The device id.
 		# 	* :sys_ver (String) Firmware version number.
-		# 	* :resolution (String) Web UI version number.
+		# 	* :app_ver (String) Web UI version number.
 		# 	* :alias (String) The assigned camera name.
 		# 	* :now (DateTime) The camera's time.
 		# 	* :tz (String) The camera time zone.
@@ -419,27 +279,7 @@ module Foscam
 		# 	* :ftp_filename  (String)
 		# 	* :ftp_numberoffiles (Fixnum)
 		# 	* :ftp_schedule_enable (FalseClass, TrueClass)
-		# 	* :ftp_schedule_sun_0 (Fixnum)
-		# 	* :ftp_schedule_sun_1 (Fixnum)
-		# 	* :ftp_schedule_sun_2 (Fixnum)
-		# 	* :ftp_schedule_mon_0 (Fixnum)
-		# 	* :ftp_schedule_mon_1 (Fixnum)
-		# 	* :ftp_schedule_mon_2 (Fixnum)
-		# 	* :ftp_schedule_tue_0 (Fixnum)
-		# 	* :ftp_schedule_tue_1 (Fixnum)
-		# 	* :ftp_schedule_tue_2 (Fixnum)
-		# 	* :ftp_schedule_wed_0 (Fixnum)
-		# 	* :ftp_schedule_wed_1 (Fixnum)
-		# 	* :ftp_schedule_wed_2 (Fixnum)
-		# 	* :ftp_schedule_thu_0 (Fixnum)
-		# 	* :ftp_schedule_thu_1 (Fixnum)
-		# 	* :ftp_schedule_thu_2 (Fixnum)
-		# 	* :ftp_schedule_fri_0 (Fixnum)
-		# 	* :ftp_schedule_fri_1 (Fixnum)
-		# 	* :ftp_schedule_fri_2 (Fixnum)
-		# 	* :ftp_schedule_sat_0 (Fixnum)
-		# 	* :ftp_schedule_sat_1 (Fixnum)
-		# 	* :ftp_schedule_sat_2 (Fixnum)
+		# 	* :ftp_schedule (Schedule::Week)
 		# 	* :alarm_motion_armed (FalseClass, TrueClass)
 		# 	* :alarm_motion_sensitivity (Fixnum)
 		# 	* :alarm_motion_compensation  (Fixnum)
@@ -454,27 +294,7 @@ module Foscam
 		# 	* :alarm_msn (FalseClass, TrueClass)
 		# 	* :alarm_http_url (String)
 		# 	* :alarm_schedule_enable (FalseClass, TrueClass)
-		# 	* :alarm_schedule_sun_0 (Fixnum)
-		# 	* :alarm_schedule_sun_1 (Fixnum)
-		# 	* :alarm_schedule_sun_2 (Fixnum)
-		# 	* :alarm_schedule_mon_0 (Fixnum)
-		# 	* :alarm_schedule_mon_1 (Fixnum)
-		# 	* :alarm_schedule_mon_2 (Fixnum)
-		# 	* :alarm_schedule_tue_0 (Fixnum)
-		# 	* :alarm_schedule_tue_1 (Fixnum)
-		# 	* :alarm_schedule_tue_2 (Fixnum)
-		# 	* :alarm_schedule_wed_0 (Fixnum)
-		# 	* :alarm_schedule_wed_1 (Fixnum)
-		# 	* :alarm_schedule_wed_2 (Fixnum)
-		# 	* :alarm_schedule_thu_0 (Fixnum)
-		# 	* :alarm_schedule_thu_1 (Fixnum)
-		# 	* :alarm_schedule_thu_2 (Fixnum)
-		# 	* :alarm_schedule_fri_0 (Fixnum)
-		# 	* :alarm_schedule_fri_1 (Fixnum)
-		# 	* :alarm_schedule_fri_2 (Fixnum)
-		# 	* :alarm_schedule_sat_0 (Fixnum)
-		# 	* :alarm_schedule_sat_1 (Fixnum)
-		# 	* :alarm_schedule_sat_2 (Fixnum)
+		# 	* :alarm_schedule (Schedule::Week)
 		# 	* :decoder_baud (Fixnum)
 		# 	* :msn_user (String)
 		# 	* :msn_pwd (String)
@@ -492,26 +312,32 @@ module Foscam
 			response = @connection.get("get_params.cgi")
 			response = response.success? ? parse_response(response) : {}
 			unless response.empty?
+				alarm_schedule = {}
+				ftp_schedule = {}
+				response.keys.each do |field|
+					ftp_match = field.to_s.match(/ftp_schedule_(.+)_(\d)/)
+					unless ftp_match.nil?
+						value = response.delete(field)
+						ftp_schedule.merge!("#{ftp_match[1]}_#{ftp_match[2]}".to_sym => value.to_i)
+					end
+
+					alarm_match = field.to_s.match(/alarm_schedule_(.+)_(\d)/)
+					unless alarm_match.nil?
+						value = response.delete(field)
+						alarm_schedule.merge!("#{alarm_match[1]}_#{alarm_match[2]}".to_sym => value.to_i)
+					end
+				end
+
+				response[:ftp_schedule] = ::Foscam::Schedule::Week.new(ftp_schedule)
+
+				response[:alarm_schedule] = ::Foscam::Schedule::Week.new(alarm_schedule)
+
 				response[:now] = ::DateTime.strptime(response[:now],'%s')
 				[:ntp_enable, :wifi_enable, :pppoe_enable, :upnp_enable, :alarm_schedule_enable, :ftp_schedule_enable].each do |field|
 					response[field] = response[field].to_i > 0
 				end
-				[
-					: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_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,
-					:daylight_savings_time, :ddns_proxy_port, :ftp_port, :mail_port, :port, :dev2_port, :dev3_port, :dev4_port, :dev5_port, :dev6_port, :dev7_port, :dev8_port, :dev9_port].each do |field|
+
+				[:daylight_savings_time, :ddns_proxy_port, :ftp_port, :mail_port, :port, :dev2_port, :dev3_port, :dev4_port, :dev5_port, :dev6_port, :dev7_port, :dev8_port, :dev9_port].each do |field|
 					response[field] = response[field].to_i
 				end
 				[:user1_pri, :user2_pri, :user3_pri, :user4_pri, :user5_pri, :user6_pri, :user7_pri, :user8_pri].each do |key|
@@ -560,11 +386,23 @@ module Foscam
 		##
 		# Set usernames, passwords and privilages
 		# @param [Hash] params
+		# @option params [String] :user1 Username of user1.
+		# @option params [String] :pwd1 Password of user1.
+		# @option params [String] :pri1 Privilages of user1.
+		# @option params [String] ...
+		# @option params [String] :user8 Username of user8.
+		# @option params [String] :pwd8 Password of user8.
+		# @option params [String] :pri8 Privilages of user8.
 		# @return [FalseClass,TrueClass] whether the request was successful.
 		def set_users(params)
 			[:user1, :pwd1, :user2, :pwd2, :user3, :pwd3, :user4, :pwd4, :user5, :pwd5, :user6, :pwd6, :user7, :pwd7, :user8, :pwd8].each do |key|
 				throw "invalid parameter value" if params.has_key?(key) && params[key].length > 12
 			end
+			# if it is one of the matching symbols then set it to the corresponding integer
+			[:pri1, :pri2, :pri3, :pri4, :pri5, :pri6, :pri7, :pri8].each do |key|
+				params[key] = USER_PERMISSIONS_ID[key] if params.has_key?(key) && params[key].is_a?(Symbol)
+			end
+
 			response = @connection.get("set_users.cgi?#{params.to_query}")
 			response.success?
 		end
@@ -576,6 +414,11 @@ module Foscam
 		##
 		# Set usernames, passwords and privilages
 		# @param [Hash] params
+		# @option params [String] :ip  if ip set to "",The device will DHCP Ip
+		# @option params [String] :mask mask
+		# @option params [String] :gateway gateway
+		# @option params [String] :dns dns server
+		# @option params [Fixnum] :port port number
 		# @return [FalseClass,TrueClass] whether the request was successful.
 		def set_network(params)
 			response = @connection.get("set_network.cgi?#{params.to_query}")
@@ -702,61 +545,39 @@ module Foscam
 
 		##
 		# Set Forbidden
-		# @param [Hash] params
-		# @option params [Fixnum] :schedule_fri_0
-		# @option params [Fixnum] :schedule_fri_1
-		# @option params [Fixnum] :schedule_fri_2
-		# @option params [Fixnum] :schedule_mon_0
-		# @option params [Fixnum] :schedule_mon_1
-		# @option params [Fixnum] :schedule_mon_2
-		# @option params [Fixnum] :schedule_sat_0
-		# @option params [Fixnum] :schedule_sat_1
-		# @option params [Fixnum] :schedule_sat_2
-		# @option params [Fixnum] :schedule_sun_0
-		# @option params [Fixnum] :schedule_sun_1
-		# @option params [Fixnum] :schedule_sun_2
-		# @option params [Fixnum] :schedule_thu_0
-		# @option params [Fixnum] :schedule_thu_1
-		# @option params [Fixnum] :schedule_thu_2
-		# @option params [Fixnum] :schedule_tue_0
-		# @option params [Fixnum] :schedule_tue_1
-		# @option params [Fixnum] :schedule_tue_2
-		# @option params [Fixnum] :schedule_wed_0
-		# @option params [Fixnum] :schedule_wed_1
-		# @option params [Fixnum] :schedule_wed_2
+		# @param [Schedule::Week] week
 		# @return [FalseClass,TrueClass] whether the request was successful.
-		def set_forbidden(params)
-			response = @connection.get("set_forbidden.cgi?#{params.to_query}")
-			response.success?
+		def set_forbidden(week)
+			if week.is_a?(Schedule::Week)
+				params = {}
+				week.to_param.each_pair do |key, value|
+					params.merge!("schedule_#{key}" => value)
+				end
+				response = @connection.get("set_forbidden.cgi?#{params.to_query}")
+				response.success?
+			else
+				false
+			end
 		end
 
 		##
 		# Returns the forbidden schedule for the camera
-		# @return [Hash] If the request is unsuccessful the hash will be empty. Otherwise it contains the following fields:
-		# 	* :schedule_sun_0 (Fixnum)
-		# 	* :schedule_sun_1 (Fixnum)
-		# 	* :schedule_sun_2 (Fixnum)
-		# 	* :schedule_mon_0 (Fixnum)
-		# 	* :schedule_mon_1 (Fixnum)
-		# 	* :schedule_mon_2 (Fixnum)
-		# 	* :schedule_tue_0 (Fixnum)
-		# 	* :schedule_tue_1 (Fixnum)
-		# 	* :schedule_tue_2 (Fixnum)
-		# 	* :schedule_wed_0 (Fixnum)
-		# 	* :schedule_wed_1 (Fixnum)
-		# 	* :schedule_wed_2 (Fixnum)
-		# 	* :schedule_thu_0 (Fixnum)
-		# 	* :schedule_thu_1 (Fixnum)
-		# 	* :schedule_thu_2 (Fixnum)
-		# 	* :schedule_fri_0 (Fixnum)
-		# 	* :schedule_fri_1 (Fixnum)
-		# 	* :schedule_fri_2 (Fixnum)
-		# 	* :schedule_sat_0 (Fixnum)
-		# 	* :schedule_sat_1 (Fixnum)
-		# 	* :schedule_sat_2 (Fixnum)
+		# @return [Schedule::Week, nil] If the request is unsuccessful then nil is returned.
 		def get_forbidden
 			response = @connection.get("get_forbidden.cgi")
-			response.success? ? parse_response(response) : {}
+			params = response.success? ? parse_response(response) : {}
+			schedule = {}
+			unless params.empty?
+				params.keys.each do |field|
+					match = field.to_s.match(/schedule_(.+)_(\d)/)
+					unless match.nil?
+						schedule.merge!("#{match[1]}_#{match[2]}".to_sym => params[field].to_i)
+					end
+				end
+				::Foscam::Schedule::Week.new(schedule)
+			else
+				nil
+			end
 		end
 
 		##