onkyo_eiscp_ruby 0.0.3 → 1.0.4

data/lib/eiscp/receiver/discovery.rb

@@ -0,0 +1,50 @@
+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
+
+          begin
+            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
+end

data/lib/eiscp/receiver.rb

@@ -1,180 +1,98 @@
-require 'socket'
-require 'eiscp/message'
 require 'resolv'
+require_relative './receiver'
+require_relative './receiver/discovery'
+require_relative './receiver/connection'
+require_relative './receiver/command_methods'
 
 module EISCP
+  # The EISCP::Receiver class is used to communicate with one or more
+  # receivers the network. A Receiver can be instantiated automatically
+  # using discovery, or by hostname and port.
+  #
+  #   receiver = EISCP::Receiver.new # find first receiver on LAN
+  #   receiver = EISCP::Receiver.new('192.168.1.12') # default port
+  #   receiver = EISCP::Receiver.new('192.168.1.12', 60129) # non standard port
+  #
   class Receiver
+    extend Discovery
+    include Connection
+    include CommandMethods
 
+    # Receiver's IP address
     attr_accessor :host
+    # Receiver's model string
     attr_accessor :model
+    # Receiver's ISCP port
     attr_accessor :port
+    # Receiver's region
     attr_accessor :area
+    # Receiver's MAC address
     attr_accessor :mac_address
 
-    ONKYO_MAGIC = Message.new("ECN", "QSTN", "x").to_eiscp
-    ONKYO_PORT = 60128
-
     # Create a new EISCP object to communicate with a receiver.
     # If no host is given, use auto discovery and create a
     # receiver object using the first host to respond.
-
-    def initialize(host = nil, port = ONKYO_PORT)
-      if host == nil
-        if first_rec = self.class.discover[0]
-          host = first_rec[1]
-          set_info first_rec[0]
+    #
+    def initialize(host = nil, info_hash = {}, &block)
+      # This defines the behavior of CommandMethods by telling it what to do wit
+      # the Message object that results from a CommandMethod being called. All
+      # we're doing here is calling #send_recv
+      #
+      CommandMethods.generate {|message|self.send_recv message}
+
+      # This proc sets the four ECN attributes and initiates a connection to the
+      # receiver.
+      #
+      set_attrs = lambda do |hash|
+        @model = hash[:model]
+        @port  = hash[:port]
+        @area  = hash[:area]
+        @mac_address = hash[:mac_address]
+        if block_given?
+          connect(@host, @port, &block)
         else
-          raise Exception
-        end
-      end
-      @host = Resolv.getaddress host
-      @port = port
-      unless @model
-        set_info get_ecn
-      end
-    end
-
-    def set_info(ecn_string)
-      array = self.class.parse_ecn(ecn_string)
-      @model = array.shift
-      @port = array.shift.to_i
-      @area = array.shift
-      @mac_address = array.shift.split("\x19")[0]
-      return self
-    end
-
-    def get_ecn
-      self.class.discover.each do |entry|
-        if @host == entry[1]
-          return entry[0]
+          connect(@host, @port)
         end
       end
-    end
-
-    # Gets the ECNQSTN response of self using @host
-    # then parses it with parse_ecn, returning an array
-    # with receiver info
-
-    def get_ecn_array
-      self.class.discover.each do |entry|
-        if @host == entry[1]
-          array = self.class.parse_ecn(entry[0])
-        end
-        return array
-      end
-    end
-
-    # Returns array containing @model, @port, @area, and @mac_address
-    # from ECNQSTN response
-
-    def self.parse_ecn(ecn_string)
-      message = EISCP::Message.parse(ecn_string)
-      message.parameter.split("/")
-    end
-
-    # Internal method for receiving data with a timeout
-
-    def self.recv(sock, timeout = 0.5)
-      data = []
-      while true
-        ready = IO.select([sock], nil, nil, timeout)
-        if ready != nil
-          then readable = ready[0]
-        else
-          return data
-        end
-
-
-        readable.each do |socket|
-          begin
-            if socket == sock
-              data << sock.recv_nonblock(1024).chomp
-            end
-          rescue IO::WaitReadable
-            retry
-          end
-        end
 
+      # This lambda sets the host IP after resolving it
+      #
+      set_host = lambda do |hostname|
+        @host = Resolv.getaddress hostname
       end
-    end
-
-    # Returns an array of arrays consisting of a discovery response packet string
-    # and the source ip address of the reciever.
-
-    def self.discover
-      sock = UDPSocket.new
-      sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
-      sock.send(ONKYO_MAGIC, 0, '<broadcast>', ONKYO_PORT)
-      data = []
-      while true
-        ready = IO.select([sock], nil, nil, 0.5)
-        if ready != nil
-          then readable = ready[0]
-        else
-          return data
-        end
-
 
-        readable.each do |socket|
-          begin
-            if socket == sock
-              msg, addr = sock.recvfrom_nonblock(1024)
-              data << [msg, addr[2]]
-            end
-          rescue IO::WaitReadable
-            retry
-          end
+      # When no host is given, the first discovered host is returned.
+      #
+      # When a host is given without a hash ::discover will be used to find
+      # a receiver that matches.
+      #
+      # Else, use the given host and hash to create a new Receiver object.
+      # This is how ::discover creates Receivers.
+      #
+      case
+      when host.nil?
+        first_found = Receiver.discover[0]
+        set_host.call first_found.host
+        set_attrs.call first_found.ecn_hash
+      when info_hash.empty?
+        set_host.call host
+        Receiver.discover.each do |receiver|
+          receiver.host == @host && set_attrs.call(receiver.ecn_hash)
         end
-
+      else
+        set_host.call host
+        set_attrs.call info_hash
       end
     end
 
-    # Sends a packet string on the network
-
-    def send(eiscp_packet)
-      sock = TCPSocket.new @host, @port
-      sock.puts eiscp_packet
-      sock.close
+    # Return ECN hash with model, port, area, and MAC address
+    #
+    def ecn_hash
+      { model: @model,
+        port: @port,
+        area: @area,
+        mac_address: @mac_address
+      }
     end
-
-    # Send a packet string and return recieved data string.
-
-    def send_recv(eiscp_packet)
-      sock = TCPSocket.new @host, @port
-      sock.puts eiscp_packet
-      return Receiver.recv(sock, 0.5)
-    end
-
-    # Open a TCP connection to the host and print all received messages until
-    # killed.
-
-    def connect(&block)
-      sock = TCPSocket.new @host, @port
-      while true
-        ready = IO.select([sock], nil, nil, nil)
-        if ready != nil
-          then readable = ready[0]
-        else
-          return
-        end
-
-        readable.each do |socket|
-          begin
-            if socket == sock
-              data = sock.recv_nonblock(1024).chomp
-              if block_given?
-                yield data
-              else
-                puts data
-              end
-            end
-          rescue IO::WaitReadable
-            retry
-          end
-        end
-
-      end
-    end
-
   end
 end

data/lib/eiscp.rb

@@ -1,9 +1,10 @@
 # Library for controlling Onkyo receivers over TCP/IP.
-
+#
 module EISCP
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end
 
-require 'eiscp/receiver'
-require 'eiscp/message'
-require 'eiscp/command'
+require_relative './eiscp/receiver'
+require_relative './eiscp/message'
+require_relative './eiscp/dictionary'
+require_relative './eiscp/parser'

data/onkyo_eiscp_ruby.gemspec

@@ -1,27 +1,28 @@
 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
+    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.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,43 @@
+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,24 @@
-require_relative "../lib/eiscp/message"
-require "test/unit"
+require_relative '../lib/eiscp/message'
+require 'minitest/autorun'
 
-class TestMessage <  Test::Unit::TestCase
-
-  
-  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,33 @@
+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,5 @@
-require_relative "../lib/eiscp/receiver"
-require "test/unit"
+require_relative '../lib/eiscp/receiver'
+require 'minitest/autorun'
 
 class TestEISCP
-
 end

metadata

@@ -1,41 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: onkyo_eiscp_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-20 00:00:00.000000000 Z
+date: 2014-09-14 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/connection.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: []
@@ -43,21 +55,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Manipulate Onkyo stereos with the eISCP protocol
 test_files:
-- test/tc_message.rb
+- test/tc_parser.rb
 - test/tc_receiver.rb
-- test/tc_command.rb
+- test/tc_dictionary.rb
+- test/tc_message.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
-
-