onkyo_eiscp_ruby 2.1.4 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48590d7db6afad487744a9ba5d783b58c3af158c3ba73adb441c23d9f493ea3b
-  data.tar.gz: d2c0e99074b3ae9dd9f5b32db926262236c4aea4f640f41fae01e2e13ad04c30
+  metadata.gz: d35b01beb072ac7058ef54920b734aff8d4d098ecc702eb9edd21ee818ad7ca0
+  data.tar.gz: f1112ac834d03f1dea2e50aeed301ac8f0e802b55b00b0f317d7802515ffa84e
 SHA512:
-  metadata.gz: e218b06b48938a41c7ce8301c8a7d697a8bae0f04eb9ba6214324ebeb1e115e769516230b48a884c535ffa191e129553d169a22eebce9ec923a8c428efc5ab56
-  data.tar.gz: 21113da05277c8e18dc6cfa64a4704f3495f606d6fed666f0100ed4ff457989baa09ac0252e96a403881cd0283d5cd8d919bc811c38a63ef019254fd55fdccc6
+  metadata.gz: f3a50446a0df21efd8dc6b2397daeb0cf791a997e7f0c27bb9d01c98b9e08fdc99cd68176b464882b29acc64a5f9cbe0748da690da51269f10f8f41f3d75dfc7
+  data.tar.gz: 65bafa48d392b8578435f006de9b27b8e58b9f16d7ccd7e2d527b38f23c0e2db187204c79f9c2dfe121021907735b51f73b82cef8fb82789ac362b5c3fec228f

data/VERSION

@@ -1 +1 @@
-2.1.4	
+2.1.5

data/bin/mock_receiver.rb

@@ -11,7 +11,8 @@ module EISCP
   #
   class MockReceiver
     DISCOVERY_IP = '255.255.255.255'
-    ONKYO_DISCOVERY_RESPONSE = Message.new('ECN', "TX-NR609/60128/DX/14DAE9E967C8\x19\r\n\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00")
+    ONKYO_DISCOVERY_RESPONSE = Message.new('ECN',
+                                           "TX-NR609/60128/DX/14DAE9E967C8\x19\r\n\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00")
 
     # Create/start the server object.
 

data/bin/onkyo.rb

@@ -115,8 +115,8 @@ class Options
           puts '    Value - Description>'
           puts "\n"
           command_hash[:values].each do |_value, attr_hash|
-          puts "      '#{EISCP::Dictionary.command_value_to_value_name(command, _value)}' - "\
-              " #{attr_hash[:description]}"
+            puts "      '#{EISCP::Dictionary.command_value_to_value_name(command, _value)}' - "\
+                " #{attr_hash[:description]}"
           end
           puts "\n"
         end

data/lib/eiscp.rb

@@ -3,7 +3,7 @@
 # Library for controlling Onkyo receivers over TCP/IP.
 #
 module EISCP
-  VERSION = '2.1.4'
+  VERSION = '2.1.5'
 end
 
 require_relative './eiscp/receiver'

data/lib/eiscp/dictionary.rb

@@ -14,14 +14,12 @@ module EISCP
     extend DictionaryHelpers
 
     class << self
-      attr_reader :zones
-      attr_reader :modelsets
-      attr_reader :commands
+      attr_reader :zones, :modelsets, :commands
     end
 
     DEFAULT_ZONE = 'main'
     @yaml_file_path = File.join(__dir__, '../../eiscp-commands.yaml')
-    @commands = YAML.load(File.read(@yaml_file_path))
+    @commands = YAML.safe_load(File.read(@yaml_file_path), permitted_classes: [Symbol])
     @modelsets = @commands[:modelsets]
     @commands.delete(:modelsets)
     @zones = @commands.map { |k, _| k }
@@ -32,11 +30,12 @@ module EISCP
         command = command[0]
         @commands[zone][command][:values].each do |value|
           value = value[0]
-          if value.is_a? Array
+          case value
+          when Array
             @additions << [zone, command, value, create_range_commands(zone, command, value)]
-          elsif value.match(/^(B|T){xx}$/)
+          when /^(B|T){xx}$/
             @additions << [zone, command, value, create_treble_bass_commands(zone, command, value)]
-          elsif value.match(/^{xx}$/)
+          when /^{xx}$/
             @additions << [zone, command, value, create_balance_commands(zone, command, value)]
           else
             next

data/lib/eiscp/dictionary/dictionary_generators.rb

@@ -37,8 +37,8 @@ module EISCP
           tmp.merge!((value[0] + v.to_s) =>
             {
               name: value[0].downcase + v,
-              description: @commands[zone][command][:values][value[0] + '{xx}'][:description].gsub(/\(.*[\]|\)]$/, v),
-              models: @commands[zone][command][:values][value[0] + '{xx}'][:models]
+              description: @commands[zone][command][:values]["#{value[0]}{xx}"][:description].gsub(/\(.*[\]|)]$/, v),
+              models: @commands[zone][command][:values]["#{value[0]}{xx}"][:models]
             })
         end
         tmp
@@ -52,7 +52,7 @@ module EISCP
           tmp.merge!(v.to_s =>
             {
               name: v.downcase,
-              description: @commands[zone][command][:values]['{xx}'][:description].gsub(/\(.*[\]|\)]$/, v),
+              description: @commands[zone][command][:values]['{xx}'][:description].gsub(/\(.*[\]|)]$/, v),
               models: @commands[zone][command][:values]['{xx}'][:models]
             })
         end

data/lib/eiscp/dictionary/dictionary_helpers.rb

@@ -52,9 +52,9 @@ module EISCP
       def command_value_to_value_name(command, value)
         zone = zone_from_command(command)
         command_value = @commands[zone][command][:values][value][:name]
-        if command_value.class == String
+        if command_value.instance_of?(String)
           command_value
-        elsif command_value.class == Array
+        elsif command_value.instance_of?(Array)
           command_value.first
         end
       rescue StandardError
@@ -65,13 +65,13 @@ module EISCP
       def command_value_name_to_value(command, value_name)
         zone = zone_from_command(command)
         @commands[zone][command][:values].each_pair do |k, v|
-          if v[:name].class == String
+          if v[:name].instance_of?(String)
             return k if v[:name] == value_name.to_s
-          elsif v[:name].class == Array
+          elsif v[:name].instance_of?(Array)
             return k if v[:name].first == value_name.to_s
           end
         end
-        return nil
+        nil
       rescue StandardError
         nil
       end

data/lib/eiscp/message.rb

@@ -15,6 +15,7 @@ module EISCP
   class Message
     # EISCP header
     attr_accessor :header
+
     # ISCP "magic" indicates the start of an eISCP message.
     MAGIC = 'ISCP'
     # eISCP header size, fixed length.

data/lib/eiscp/parser/eiscp_parser.rb

@@ -17,19 +17,24 @@ module EISCP
           unit_type: msg.unit_type,
           start: msg.start
         )
-        packet.header = {
+        packet.header = create_header(array)
+        packet
+      end
+
+      def self.create_header(array)
+        {
           magic: array[0],
           header_size: array[1],
           data_size: array[2],
           version: array[3],
           reserved: array[4]
         }
-        packet
       end
 
       def self.validate(packet)
         packet.header.header_size.size == packet.command.size
       end
+        
     end
 
     class EISCPParserException < RuntimeError; end

data/lib/eiscp/parser/iscp_parser.rb

@@ -6,7 +6,7 @@ module EISCP
     #
     module ISCPParser
       # Regexp for parsing ISCP messages
-      REGEX = /(?<start>!)?(?<unit_type>(\d|x))?(?<command>[A-Z]{3})\s?(?<value>.*?)(?<terminator>[[:cntrl:]]*$)/.freeze
+      REGEX = /(?<start>!)?(?<unit_type>(?:\d|x))?(?<command>[A-Z]{3})\s?(?<value>.*?)(?<terminator>[[:cntrl:]]*$)/
       def self.parse(string)
         match = string.match(REGEX)
 
@@ -17,9 +17,7 @@ module EISCP
         hash.delete_if { |_, v| v.nil? || v == '' }
 
         # Convert keys to symbols
-        hash = hash.each_with_object({}) do |(k, v), memo|
-          memo[k.to_sym] = v
-        end
+        hash = hash.transform_keys(&:to_sym)
 
         Message.new(**hash)
       end

data/lib/eiscp/receiver.rb

@@ -133,12 +133,11 @@ module EISCP
     # Sends an EISCP::Message object or string on the network
     #
     def send(eiscp)
-      if (@socket.nil? || @socket.closed?) then
-        connect
-      end
-      if eiscp.is_a? EISCP::Message
+      connect if @socket.nil? || @socket.closed?
+      case eiscp
+      when EISCP::Message
         @socket.puts(eiscp.to_eiscp)
-      elsif eiscp.is_a? String
+      when String
         @socket.puts eiscp
       end
     end
@@ -148,8 +147,7 @@ module EISCP
     def recv
       data = String.new
       data << @socket.gets until data.match(/\r\n$/)
-      message = Parser.parse(data)
-      message
+      Parser.parse(data)
     end
 
     # Sends an EISCP::Message object or string on the network and returns recieved data string.
@@ -190,13 +188,7 @@ module EISCP
             info[:values].each do |value, _|
               next unless value == 'QSTN'
 
-              send(Parser.parse(command + 'QSTN'))
-              # If we send any faster we risk making the stereo drop replies.
-              # A dropped reply is not necessarily indicative of the
-              # receiver's failure to receive the command and change state
-              # accordingly. In this case, we're only making queries, so we do
-              # want to capture every reply.
-              sleep DEFAULT_TIMEOUT
+              send_recv(Parser.parse("#{command}QSTN"))
             end
           end
         end

data/lib/eiscp/receiver/command_methods.rb

@@ -16,7 +16,7 @@ module EISCP
           Dictionary.commands[zone].each do |command, _values|
             command_name = Dictionary.command_to_name(command).to_s.gsub(/-/, '_')
             define_method(command_name) do |v|
-              instance_exec Parser.parse(command_name.gsub(/_/, '-') + ' ' + v), &block
+              instance_exec Parser.parse("#{command_name.gsub(/_/, '-')} #{v}"), &block
             end
           rescue StandardError => e
             puts e

data/test/tc_dictionary.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../lib/eiscp/dictionary.rb'
+require_relative '../lib/eiscp/dictionary'
 require 'minitest/autorun'
 
 class TestDictionary < MiniTest::Test

data/test/tc_message.rb

@@ -8,7 +8,10 @@ class TestMessage <  MiniTest::Test
   DISCOVERY_STRING = DISCOVERY_PACKET.to_eiscp
 
   def test_create_discovery_iscp_message
-    assert_equal(EISCP::Message.new(command: 'ECN', value: 'QSTN', terminator: "\r\n", unit_type: 'x', start: '!').to_iscp, '!xECNQSTN')
+    assert_equal(
+      EISCP::Message.new(command: 'ECN', value: 'QSTN', terminator: "\r\n", unit_type: 'x',
+                         start: '!').to_iscp, '!xECNQSTN'
+    )
   end
 
   def test_create_messages

data/test/tc_parser.rb

@@ -29,6 +29,6 @@ class TestParser < MiniTest::Test
   end
 
   def test_return_nil_for_fake_human_readable
-    assert_equal(EISCP::Parser.parse('fake-command value'), nil)
+    assert_nil(EISCP::Parser.parse('fake-command value'))
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onkyo_eiscp_ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.1.5
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies: []
 description: "\n    Control Onkyo receivers over the network.Use the provided binary
   or\n    require the library for use in your scripts.\n  "