easy_upnp 0.3.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e627952f646058b6e52e0e07dd1d41e3537239d
-  data.tar.gz: ff1632d0686e54b5af395bdee11d355d0af23020
+  metadata.gz: 14a33377666a3b363416fdc8080e4bf411f2574d
+  data.tar.gz: b6c87a73312c8c4002b9d4d1206518f2f43c199a
 SHA512:
-  metadata.gz: 7b3b414baf2608cbb3b1a86fae78b1cf4081c8610ad65c1ec7dbcc7cc29d0746cbd87e96c1c3dc2051dfa69d5569913dc2dadf0c7a29da0423edcbb8885ad8a9
-  data.tar.gz: 3a494127415a59897a9573d6c0af584980c88dce64c971f6a16b05ac43d0264ed7279d6ef0fe01a8f44279a073e53f47a7c422bcf7c569acb0fa41d2c270db9c
+  metadata.gz: dcd63c1ca7bd1060112f5da3e12b8b05f8b8ab34053e3f57e93eb4c67e0015ce1d33d54505d7374c19c0e7c2d893cd95e129f8f5bce9fbaabe29de0659777d2d
+  data.tar.gz: ef39cf1f54bbb336e53df619f62f9a181f7f5050baec03e83e7495cddf809052d45af2caf1fb958493c5fbc87b792f9bad1fa8b9b28c0d503002a3e17887fadd

data/lib/easy_upnp/argument_validator.rb

@@ -0,0 +1,125 @@
+module EasyUpnp
+  class ArgumentValidator
+    class Builder
+      def initialize(&block)
+        @validators = {}
+        block.call(self) if block
+      end
+
+      def in_range(min, max, step = 1)
+        add_validator(RangeValidator.new((min..max).step(step)))
+      end
+
+      def allowed_values(*values)
+        add_validator(AllowedValueValidator.new(*values))
+      end
+
+      def type(type)
+        add_validator(TypeValidator.new(type))
+      end
+
+      def add_validator(validator)
+        @validators[validator.class] = validator
+      end
+
+      def build
+        ArgumentValidator.new(@validators)
+      end
+    end
+
+    class RangeValidator
+      attr_reader :range
+
+      def initialize(range)
+        @range = range
+      end
+
+      def validate(value)
+        if !@range.include?(value)
+          raise ArgumentError, "#{value} is not in allowed range of values: #{@range.inspect}"
+        end
+      end
+    end
+
+    class AllowedValueValidator
+      attr_reader :allowed_values
+
+      def initialize(*allowed_values)
+        @allowed_values = allowed_values
+      end
+
+      def validate(value)
+        if !@allowed_values.include?(value)
+          raise ArgumentError, "#{value} is not in list of allowed values: #{@allowed_values.inspect}"
+        end
+      end
+    end
+
+    class TypeValidator
+      # Valid UPnP types for each ruby class
+      RUBY_TYPE_TO_UPNP_TYPE = {
+        Float: %w{r4 r8 number fixed.14.4 float},
+        Integer: %w{ui1 ui2 ui4 i1 i2 i4 int},
+        String: %w{char string bin.base64 bin.hex uri uuid},
+        TrueClass: %w{bool boolean},
+        FalseClass: %w{bool boolean},
+        DateTime: %w{date dateTime dateTime.tz time time.tz},
+        Time: %w{date dateTime dateTime.tz time time.tz},
+        Date: %w{date dateTime time}
+      }
+
+      # Inversion of RUBY_TYPE_TO_UPNP_TYPE.
+      UPNP_TYPE_VALID_CLASSES = Hash[
+        RUBY_TYPE_TO_UPNP_TYPE.map { |k,v|
+          k = Kernel.const_get(k)
+          v.map { |x| [x, k] }
+        }.reduce({}) { |a,i|
+          Hash[i].each { |x,y| a[x] ||= []; a[x] << y }
+          a
+        }
+      ]
+
+      attr_reader :valid_classes
+
+      def initialize(type)
+        @valid_classes = UPNP_TYPE_VALID_CLASSES[type]
+        raise ArgumentError, "Unrecognized UPnP type: #{type}" if @valid_classes.nil?
+      end
+
+      def validate(value)
+        if !@valid_classes.any? { |x| value.is_a?(x) }
+          raise ArgumentError, "#{value} is the wrong type. Should be one of: #{@valid_classes.inspect}"
+        end
+      end
+    end
+
+    def initialize(validators)
+      @validators = validators
+    end
+
+    def validate(value)
+      @validators.each { |_, v| v.validate(value) }
+      true
+    end
+
+    def required_class
+      return nil unless @validators[TypeValidator]
+      c = @validators[TypeValidator].valid_classes
+      c.size == 1 ? c.first : c
+    end
+
+    def allowed_values
+      return nil unless @validators[AllowedValueValidator]
+      @validators[AllowedValueValidator].allowed_values
+    end
+
+    def valid_range
+      return nil unless @validators[RangeValidator]
+      @validators[RangeValidator].range
+    end
+
+    def self.build(&block)
+      Builder.new(&block).build
+    end
+  end
+end

data/lib/easy_upnp/device_control_point.rb

@@ -3,6 +3,7 @@ require 'open-uri'
 require 'nori'
 
 require_relative 'logger'
+require_relative 'argument_validator'
 
 module EasyUpnp
   class DeviceControlPoint
@@ -10,7 +11,8 @@ module EasyUpnp
 
     class Options
       DEFAULTS = {
-        advanced_typecasting: true
+        advanced_typecasting: true,
+        validate_arguments: false
       }
 
       attr_reader :options
@@ -57,11 +59,29 @@ module EasyUpnp
       definition_xml.remove_namespaces!
 
       service_methods = []
+      service_methods_args = {}
       definition_xml.xpath('//actionList/action').map do |action|
-        service_methods.push define_action(action)
+        service_methods.push(define_action(action))
+
+        name = action.xpath('name').text
+        args = {}
+        action.xpath('argumentList/argument').map do |arg|
+          arg_name = arg.xpath('name').text
+          arg_ref = arg.xpath('relatedStateVariable').text
+          args[arg_name.to_sym] = arg_ref.to_sym
+        end
+        service_methods_args[name.to_sym] = args
+      end
+
+      arg_validators = {}
+      definition_xml.xpath('//serviceStateTable/stateVariable').map do |var|
+        name = var.xpath('name').text
+        arg_validators[name.to_sym] = extract_validators(var)
       end
 
       @service_methods = service_methods
+      @service_methods_args = service_methods_args
+      @arg_validators = arg_validators
     end
 
     def to_params
@@ -111,8 +131,38 @@ module EasyUpnp
       end
     end
 
+    def arg_validator(method, arg)
+      method_args = @service_methods_args[method.to_sym]
+      raise ArgumentError, "Unknown method: #{method}" if method_args.nil?
+
+      arg_ref = method_args[arg.to_sym]
+      raise ArgumentValidator, "Unknown argument: #{arg}" if arg_ref.nil?
+
+      @arg_validators[arg_ref]
+    end
+
     private
 
+    def extract_validators(var)
+      ArgumentValidator.build do |v|
+        v.type(var.xpath('dataType').text)
+
+        if (range = var.xpath('allowedValueRange')).any?
+          min = range.xpath('minimum').text
+          max = range.xpath('maximum').text
+          step = range.xpath('step')
+          step = step.any? ? step.text : 1
+
+          v.in_range(min.to_i, max.to_i, step.to_i)
+        end
+
+        if (list = var.xpath('allowedValueList')).any?
+          allowed_values = list.xpath('allowedValue').map { |x| x.text }
+          v.allowed_values(*allowed_values)
+        end
+      end
+    end
+
     def define_action(action)
       action = Nori.new.parse(action.to_xml)['action']
       action_name = action['name']
@@ -138,6 +188,16 @@ module EasyUpnp
                                      " Supported args: #{input_args}"
         end
 
+        if @options.validate_arguments
+          args_hash.each { |k,v|
+            begin
+              arg_validator(action['name'], k).validate(v)
+            rescue ArgumentError => e
+              raise ArgumentError, "Invalid value for argument #{k}: #{e}"
+            end
+          }
+        end
+
         attrs = {
             soap_action: "#{@urn}##{action_name}",
             attributes: {

data/lib/easy_upnp/version.rb

@@ -1,3 +1,3 @@
 module EasyUpnp
-  VERSION = '0.3.2'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_upnp
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.1
 platform: ruby
 authors:
 - Christopher Mullins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-01 00:00:00.000000000 Z
+date: 2016-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -94,6 +94,7 @@ files:
 - Rakefile
 - bin/upnp-list
 - easy_upnp.gemspec
+- lib/easy_upnp/argument_validator.rb
 - lib/easy_upnp/device_control_point.rb
 - lib/easy_upnp/logger.rb
 - lib/easy_upnp/ssdp_searcher.rb