maxcube-client 0.4.1 → 0.5.0

data/lib/maxcube/network/tcp/sample_server.rb

@@ -3,6 +3,7 @@ require 'maxcube/network/tcp'
 module MaxCube
   module Network
     module TCP
+      # Simple TCP server for Cube protocol testing purposes.
       class SampleServer
         def initialize(port = PORT)
           @port = port

data/lib/maxcube/network/udp.rb

@@ -4,7 +4,10 @@ require 'maxcube/messages/udp/serializer'
 
 module MaxCube
   module Network
+    # This module contains classes aimed onto UDP network tools
+    # related to Cube protocol.
     module UDP
+      # Common port used in Cube UDP communication.
       PORT = 23_272
     end
   end

data/lib/maxcube/network/udp/client.rb

@@ -3,6 +3,8 @@ require 'maxcube/network/udp'
 module MaxCube
   module Network
     module UDP
+      # Class that provides yet only basic UDP communication
+      # with Cube devices.
       class Client
         def initialize(port = PORT)
           @socket = UDPSocket.new

data/lib/maxcube/network/udp/sample_socket.rb

@@ -3,6 +3,7 @@ require 'maxcube/network/udp'
 module MaxCube
   module Network
     module UDP
+      # Simple UDP 'server' for Cube protocol testing purposes.
       class SampleSocket
         def initialize(port = PORT)
           @port = port

data/lib/maxcube/runner.rb

@@ -0,0 +1,45 @@
+require 'maxcube/network/tcp/client'
+require 'maxcube/network/udp/client'
+
+module MaxCube
+  # Module that provides running of Cube clients:
+  # {Network::TCP::Client} and {Network::UDP::Client}
+  class Runner
+    # These will display help message.
+    HELP_KEYS = %w[h -h help -help --help ? -?].freeze
+
+    # Assigns command line arguments to internal variable.
+    def initialize(argv)
+      @argv = argv
+    end
+
+    # Runs either TCP or UDP client.
+    def run
+      help = @argv.size == 1 && HELP_KEYS.include?(@argv.first)
+      wrong_args = @argv.size > 2
+
+      if help || wrong_args
+        if wrong_args
+          puts "Wrong number of arguments: #{@argv.size} (expected: 0..2)"
+        end
+        puts "USAGE: ruby #{__FILE__} [<help>|<host>] [<port>]\n" \
+             "  <help> - on of these: #{HELP_KEYS}\n\n" \
+             "If no arguments are given, UDP discovery is performed.\n" \
+             'Otherwise, TCP client is launched (unless help command entered).'
+        exit
+      end
+
+      if @argv.empty?
+        puts "No arguments given - performing UDP discovery ...\n" \
+             "(For usage message, type one of these: #{HELP_KEYS})\n\n"
+        client = MaxCube::Network::UDP::Client.new
+        client.discovery
+        client.close
+        exit
+      end
+
+      client = MaxCube::Network::TCP::Client.new
+      client.connect(*@argv)
+    end
+  end
+end

data/lib/maxcube/version.rb

@@ -1,4 +1,5 @@
 
 module MaxCube
-  VERSION = '0.4.1'.freeze
+  # Project (package) version
+  VERSION = '0.5.0'.freeze
 end

data/maxcube-client.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.metadata['yard.run'] = 'yard'
 
   spec.required_ruby_version = '>= 2.2'
 
@@ -26,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop", "~> 0.50"
+  spec.add_development_dependency "yard", "~> 0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maxcube-client
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Tomáš Kolárik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-15 00:00:00.000000000 Z
+date: 2018-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.50'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: 
 email:
 - tomaqa@gmail.com
@@ -73,7 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - ".rubocop.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.md
 - README.md
@@ -91,6 +107,69 @@ files:
 - data/load/set_valve
 - data/load/url
 - data/load/wake
+- doc/MaxCube.html
+- doc/MaxCube/Messages.html
+- doc/MaxCube/Messages/Handler.html
+- doc/MaxCube/Messages/InvalidMessage.html
+- doc/MaxCube/Messages/InvalidMessageBody.html
+- doc/MaxCube/Messages/InvalidMessageFormat.html
+- doc/MaxCube/Messages/InvalidMessageLength.html
+- doc/MaxCube/Messages/InvalidMessageType.html
+- doc/MaxCube/Messages/Parser.html
+- doc/MaxCube/Messages/Serializer.html
+- doc/MaxCube/Messages/TCP.html
+- doc/MaxCube/Messages/TCP/Handler.html
+- doc/MaxCube/Messages/TCP/Parser.html
+- doc/MaxCube/Messages/TCP/Parser/MessageA.html
+- doc/MaxCube/Messages/TCP/Parser/MessageC.html
+- doc/MaxCube/Messages/TCP/Parser/MessageF.html
+- doc/MaxCube/Messages/TCP/Parser/MessageH.html
+- doc/MaxCube/Messages/TCP/Parser/MessageL.html
+- doc/MaxCube/Messages/TCP/Parser/MessageM.html
+- doc/MaxCube/Messages/TCP/Parser/MessageN.html
+- doc/MaxCube/Messages/TCP/Parser/MessageS.html
+- doc/MaxCube/Messages/TCP/Serializer.html
+- doc/MaxCube/Messages/TCP/Serializer/MessageA.html
+- doc/MaxCube/Messages/TCP/Serializer/MessageC.html
+- doc/MaxCube/Messages/TCP/Serializer/MessageF.html
+- doc/MaxCube/Messages/TCP/Serializer/MessageL.html
+- doc/MaxCube/Messages/TCP/Serializer/MessageM.html
+- doc/MaxCube/Messages/TCP/Serializer/MessageN.html
+- doc/MaxCube/Messages/TCP/Serializer/MessageQ.html
+- doc/MaxCube/Messages/TCP/Serializer/MessageS.html
+- doc/MaxCube/Messages/TCP/Serializer/MessageT.html
+- doc/MaxCube/Messages/TCP/Serializer/MessageU.html
+- doc/MaxCube/Messages/TCP/Serializer/MessageZ.html
+- doc/MaxCube/Messages/UDP.html
+- doc/MaxCube/Messages/UDP/Handler.html
+- doc/MaxCube/Messages/UDP/Parser.html
+- doc/MaxCube/Messages/UDP/Parser/MessageH.html
+- doc/MaxCube/Messages/UDP/Parser/MessageI.html
+- doc/MaxCube/Messages/UDP/Parser/MessageN.html
+- doc/MaxCube/Messages/UDP/Serializer.html
+- doc/MaxCube/Network.html
+- doc/MaxCube/Network/TCP.html
+- doc/MaxCube/Network/TCP/Client.html
+- doc/MaxCube/Network/TCP/Client/Commands.html
+- doc/MaxCube/Network/TCP/SampleServer.html
+- doc/MaxCube/Network/UDP.html
+- doc/MaxCube/Network/UDP/Client.html
+- doc/MaxCube/Network/UDP/SampleSocket.html
+- doc/MaxCube/Runner.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - lib/maxcube.rb
 - lib/maxcube/messages.rb
 - lib/maxcube/messages/handler.rb
@@ -127,12 +206,14 @@ files:
 - lib/maxcube/network/udp.rb
 - lib/maxcube/network/udp/client.rb
 - lib/maxcube/network/udp/sample_socket.rb
+- lib/maxcube/runner.rb
 - lib/maxcube/version.rb
 - maxcube-client.gemspec
 homepage: https://github.com/Tomaqa/maxcube-client
 licenses:
 - MIT
-metadata: {}
+metadata:
+  yard.run: yard
 post_install_message: 
 rdoc_options: []
 require_paths: