onkyo_eiscp_ruby 0.0.3 → 2.1.2

data/lib/eiscp/receiver/command_methods.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../parser'
+require_relative '../dictionary'
+
+module EISCP
+  class Receiver
+    # Iterates through every available command and defines a method to call that
+    # command. It's intended to be used through Receiver and uses methods included
+    # by Receiver::Connection. Each method accepts a string that should match the
+    # human readable name of a valid value for that command.
+    #
+    module CommandMethods
+      def self.generate(&block)
+        Dictionary.zones.each do |zone|
+          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
+            end
+          rescue StandardError => e
+            puts e
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eiscp/receiver/discovery.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'socket'
+require_relative '../message'
+require_relative '../parser'
+
+module EISCP
+  class Receiver
+    # This module discovers receivers on the local LAN.
+    #
+    module Discovery
+      # ISCP Magic Packet for Autodiscovery
+      ONKYO_MAGIC = Message.new(command: 'ECN', value: 'QSTN', terminator: "\r\n", unit_type: 'x').to_eiscp
+
+      # Populates Receiver attributes with info from ECNQSTN response.
+      #
+      def ecn_string_to_ecn_array(ecn_string)
+        hash = {}
+        message = Parser.parse(ecn_string)
+        array = message.value.split('/')
+        hash[:model] = array.shift
+        hash[:port] = array.shift.to_i
+        hash[:area] = array.shift
+        hash[:mac_address] = array.shift
+        hash
+      end
+
+      # Returns an array of discovered Receiver objects.
+      #
+      def discover(discovery_port = Receiver::ONKYO_PORT)
+        sock = UDPSocket.new
+        sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
+        sock.send(ONKYO_MAGIC, 0, '<broadcast>', discovery_port)
+        data = []
+        loop do
+          msg, addr = sock.recvfrom_nonblock(1024)
+          data << Receiver.new(addr[2], ecn_string_to_ecn_array(msg))
+        rescue IO::WaitReadable
+          io = IO.select([sock], nil, nil, 0.5)
+          if io.nil?
+            return data
+          else
+            retry
+          end
+        end
+      end
+    end
+  end
+end

data/onkyo_eiscp_ruby.gemspec

@@ -1,27 +1,29 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |s|
   s.name         = 'onkyo_eiscp_ruby'
   s.version      = File.read(File.expand_path('VERSION', File.dirname(__FILE__))).strip
+  s.licenses = ['MIT']
   s.platform     = Gem::Platform::RUBY
   s.summary      = 'Manipulate Onkyo stereos with the eISCP protocol'
   s.files        = Dir.glob('{bin,config,lib,test,doc}/**/*') +
-    ["VERSION", "onkyo_eiscp_ruby.gemspec", "eiscp-commands.yaml"]
-  s.extra_rdoc_files = ["README.md"]
+                   ['VERSION', 'onkyo_eiscp_ruby.gemspec', 'eiscp-commands.yaml']
+  s.extra_rdoc_files = ['README.md']
   s.require_path = 'lib'
 
-  s.homepage     = "https://github.com/mikerodrigues/onkyo_eiscp_ruby"
+  s.homepage     = 'https://github.com/mikerodrigues/onkyo_eiscp_ruby'
 
-  s.description  = %q(
-    Control Onkyo receivers over the network.Use the provided binary script or
+  s.description  = '
+    Control Onkyo receivers over the network.Use the provided binary or
     require the library for use in your scripts.
-  )
+  '
 
-  s.author       = "Michael Rodrigues"
-  s.email        = "mikebrodrigues@gmail.com"
+  s.author       = 'Michael Rodrigues'
+  s.email        = 'mikebrodrigues@gmail.com'
 
-  s.test_files = Dir[ 'test/tc*.rb' ]
-  s.executables = %w(
+  s.test_files = Dir['test/tc*.rb']
+  s.executables = %w[
     onkyo.rb
-    onkyo-server.rb
-  )
-
+    onkyo_server.rb
+  ]
 end

data/test/tc_dictionary.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative '../lib/eiscp/dictionary.rb'
+require 'minitest/autorun'
+
+class TestDictionary < MiniTest::Test
+  def test_zone_from_command
+    assert_equal(EISCP::Dictionary.zone_from_command('PWR'), 'main')
+    assert_equal(EISCP::Dictionary.zone_from_command('ZPW'), 'zone2')
+    assert_equal(EISCP::Dictionary.zone_from_command('CDS'), 'dock')
+  end
+
+  def test_command_to_name
+    assert_equal(EISCP::Dictionary.command_to_name('PWR'), 'system-power')
+    assert_equal(EISCP::Dictionary.command_to_name('ZPW'), 'power2')
+    assert_equal(EISCP::Dictionary.command_to_name('PW3'), 'power3')
+    assert_equal(EISCP::Dictionary.command_to_name('PW4'), 'power4')
+  end
+
+  def test_command_name_to_command
+    assert_equal(EISCP::Dictionary.command_name_to_command('system-power'), 'PWR')
+    assert_equal(EISCP::Dictionary.command_name_to_command('master-volume'), 'MVL')
+    assert_equal(EISCP::Dictionary.command_name_to_command('power2'), 'ZPW')
+  end
+
+  def test_command_value_to_value_name
+    assert_equal(EISCP::Dictionary.command_value_to_value_name('PWR', '01'), 'on')
+    assert_equal(EISCP::Dictionary.command_value_to_value_name('PWR', 'QSTN'), 'query')
+  end
+
+  def test_command_value_name_to_value
+    assert_equal(EISCP::Dictionary.command_value_name_to_value('PWR', 'on'), '01')
+    assert_equal(EISCP::Dictionary.command_value_name_to_value('ZPW', 'on'), '01')
+  end
+
+  def test_description_from_command_name
+    assert_equal(EISCP::Dictionary.description_from_command_name('system-power', 'main'), 'System Power Command')
+    assert_equal(EISCP::Dictionary.description_from_command_name('power2', 'zone2'), 'Zone2 Power Command')
+  end
+
+  def test_description_from_command
+    assert_equal(EISCP::Dictionary.description_from_command('PWR'), 'System Power Command')
+    assert_equal(EISCP::Dictionary.description_from_command('ZPW'), 'Zone2 Power Command')
+  end
+end

data/test/tc_message.rb

@@ -1,27 +1,26 @@
-require_relative "../lib/eiscp/message"
-require "test/unit"
+# frozen_string_literal: true
 
-class TestMessage <  Test::Unit::TestCase
+require_relative '../lib/eiscp/message'
+require 'minitest/autorun'
 
-  
-  DISCOVERY_PACKET = EISCP::Message.new('ECN', 'QSTN', 'x', '!')
+class TestMessage <  MiniTest::Test
+  DISCOVERY_PACKET = EISCP::Message.new(command: 'ECN', value: 'QSTN', terminator: "\r\n", unit_type: 'x', start: '!')
   DISCOVERY_STRING = DISCOVERY_PACKET.to_eiscp
 
-
   def test_create_discovery_iscp_message
-    assert_equal(EISCP::Message.new("ECN", "QSTN", "x", "!").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_parse_discovery_iscp_message
-    assert_equal(EISCP::Message.parse("!xECNQSTN").to_iscp, "!xECNQSTN")
+  def test_create_messages
+    assert_equal(EISCP::Message.new(command: 'PWR', value: '01').to_iscp, '!1PWR01')
+    assert_equal(EISCP::Message.new(command: 'MVL', value: 'QSTN').to_iscp, '!1MVLQSTN')
   end
 
   def test_create_discovery_packet_string
     assert_equal(DISCOVERY_PACKET.to_eiscp, DISCOVERY_STRING)
   end
 
-  def test_parse_discovery_packet_string
-    assert_equal(EISCP::Message.parse(DISCOVERY_STRING).to_eiscp, DISCOVERY_PACKET.to_eiscp)
+  def test_validate_valid_message_with_variable
+    # Commands that return something unexpected like an artist name
   end
-
 end

data/test/tc_parser.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../lib/eiscp/parser'
+require_relative '../lib/eiscp/message'
+require 'minitest/autorun'
+
+class TestParser < MiniTest::Test
+  DISCOVERY_PACKET = EISCP::Message.new(command: 'ECN', value: 'QSTN', terminator: "\r\n", unit_type: 'x', start: '!')
+  DISCOVERY_STRING = DISCOVERY_PACKET.to_eiscp
+
+  def test_parse_discovery_iscp_message
+    assert_equal(EISCP::Parser.parse('!xECNQSTN').to_iscp, '!xECNQSTN')
+  end
+
+  def test_parse_iscp_messages
+    assert_equal(EISCP::Parser.parse('PWR 01').to_iscp, '!1PWR01')
+    assert_equal(EISCP::Parser.parse('PWR01').to_iscp, '!1PWR01')
+    assert_equal(EISCP::Parser.parse('!1PWR01').to_iscp, '!1PWR01')
+    assert_equal(EISCP::Parser.parse('!1PWR 01').to_iscp, '!1PWR01')
+  end
+
+  def test_parse_discovery_packet_string
+    assert_equal(EISCP::Parser.parse(DISCOVERY_STRING).to_eiscp, DISCOVERY_PACKET.to_eiscp)
+  end
+
+  def test_parse_human_readable
+    assert_equal(EISCP::Parser.parse('system-power on'), EISCP::Message.new(command: 'PWR', value: '01'))
+    assert_equal(EISCP::Parser.parse('main system-power on'), EISCP::Message.new(command: 'PWR', value: '01'))
+  end
+
+  def test_return_nil_for_fake_human_readable
+    assert_equal(EISCP::Parser.parse('fake-command value'), nil)
+  end
+end

data/test/tc_receiver.rb

@@ -1,6 +1,7 @@
-require_relative "../lib/eiscp/receiver"
-require "test/unit"
+# frozen_string_literal: true
 
-class TestEISCP
+require_relative '../lib/eiscp/receiver'
+require 'minitest/autorun'
 
+class TestEISCP
 end

metadata

@@ -1,41 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: onkyo_eiscp_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 2.1.2
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-20 00:00:00.000000000 Z
+date: 2021-03-21 00:00:00.000000000 Z
 dependencies: []
 description: "\n    Control Onkyo receivers over the network.Use the provided binary
-  script or\n    require the library for use in your scripts.\n  "
+  or\n    require the library for use in your scripts.\n  "
 email: mikebrodrigues@gmail.com
 executables:
 - onkyo.rb
-- onkyo-server.rb
+- onkyo_server.rb
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
 - README.md
 - VERSION
-- bin/onkyo-server.rb
+- bin/mock_receiver.rb
 - bin/onkyo.rb
+- bin/onkyo_server.rb
 - eiscp-commands.yaml
 - lib/eiscp.rb
-- lib/eiscp/command.rb
+- lib/eiscp/dictionary.rb
+- lib/eiscp/dictionary/dictionary_generators.rb
+- lib/eiscp/dictionary/dictionary_helpers.rb
 - lib/eiscp/message.rb
-- lib/eiscp/mock_receiver.rb
+- lib/eiscp/parser.rb
+- lib/eiscp/parser/dynamic_value_parser.rb
+- lib/eiscp/parser/eiscp_parser.rb
+- lib/eiscp/parser/human_readable_parser.rb
+- lib/eiscp/parser/iscp_parser.rb
 - lib/eiscp/receiver.rb
+- lib/eiscp/receiver/command_methods.rb
+- lib/eiscp/receiver/discovery.rb
 - onkyo_eiscp_ruby.gemspec
-- test/tc_command.rb
+- test/tc_dictionary.rb
 - test/tc_message.rb
+- test/tc_parser.rb
 - test/tc_receiver.rb
 homepage: https://github.com/mikerodrigues/onkyo_eiscp_ruby
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -52,12 +63,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Manipulate Onkyo stereos with the eISCP protocol
 test_files:
+- test/tc_dictionary.rb
 - test/tc_message.rb
+- test/tc_parser.rb
 - test/tc_receiver.rb
-- test/tc_command.rb

data/lib/eiscp/command.rb

@@ -1,99 +0,0 @@
-require 'yaml'
-require 'eiscp/receiver'
-require 'ostruct'
-
-module Command
-
-  @@yaml_file_path = File.join(File.expand_path(File.dirname(__FILE__)), '../../eiscp-commands.yaml')
-  @@yaml_object = YAML.load(File.read(@@yaml_file_path))
-  @@modelsets = @@yaml_object["modelsets"]
-  @@yaml_object.delete("modelsets")
-  @@zones = @@yaml_object.map{|k, v| k}
-  @@zones.each {|zone| class_variable_set("@@#{zone}", nil) }
-  @@main = @@yaml_object['main']
-
-  def self.command_to_name(command)
-    return @@main[command]['name']
-  end
-
-  def self.command_name_to_command(name)
-    @@main.each_pair do |command, attrs|
-      if attrs['name'] == name
-        return command
-      end
-    end
-  end
-
-  def self.command_value_to_value_name(command, value)
-    return @@main[command]['values'][value]['name'] 
-  end
-
-  def self.command_value_name_to_value(command, name)
-    @@main[command]['values'].each do |k, v|
-      if v['name'] == name.to_s
-        return k
-      end
-    end
-  end
-
-
-  def self.description_from_command_name(name)
-    @@main.each_pair do |command, attrs|
-      if attrs['name'] == name
-        return @@main[command]['description']
-      end
-    end
-  end
-
-  def self.description_from_command(command)
-    return @@main[command]['description']
-  end
-
-  def self.description_from_command_value(command, value)
-    return @@main[command]['values'].select do |k, v| 
-      if k == value
-        return v['description']
-      end
-    end
-  end
-
-  def self.list_all_commands
-    @@main.each_pair do |command, attrs|
-      puts "#{command} - #{attrs['name']}: #{attrs['description']}"
-      attrs['values'].each_pair do |k, v|
-        puts "--#{k}:#{v}"
-      end
-    end
-  end
-
-  def self.list_compatible_commands(modelstring)
-    sets = [] 
-    @@modelsets.each_pair do |set, array|
-      if array.include? modelstring
-        sets << set
-      end
-    end
-    return sets
-  end
-
-  def self.parse(string)
-    array = string.split(" ")
-    zone = 'main'
-    command_name = ''
-    parameter_name = ''
-    if array.count == 3
-      zone = array.shift
-      command_name = array.shift
-      parameter_name = array.shift
-    elsif array.count == 2
-      command_name = array.shift
-      parameter_name = array.shift
-    end
-    command = Command.command_name_to_command(command_name)
-    parameter = Command.command_value_name_to_value(command, parameter_name)
-    return EISCP::Message.new(command, parameter)
-  end
-
-end
-
-

data/lib/eiscp/mock_receiver.rb

@@ -1,22 +0,0 @@
-require 'socket'
-require 'eiscp/receiver'
-require 'eiscp/message'
-
-# Mock server that only responds to ECNQSTN.
-
-module EISCP
-  class MockReceiver
-
-    ONKYO_DISCOVERY_RESPONSE =  Message.new("ECN", "TX-NR609/60128/DX/001122334455")
-
-    # Create/start the server object.
-
-    def initialize
-      Socket.udp_server_loop("255.255.255.255", EISCP::ONKYO_PORT) do |msg, msg_src|
-        msg_src.reply ONKYO_DISCOVERY_RESPONSE.to_eiscp
-        puts msg
-      end
-    end
-
-  end
-end