roku_builder 3.10.1 → 3.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bd8c2a637ccfb6ed15cb7f75744609c341ed98e
-  data.tar.gz: 73b474739d29c61ff97316f648928dd3c2963423
+  metadata.gz: 89eb827a28c4963403052c57452f7d8eb6c0f23c
+  data.tar.gz: 3ad6a214d6c19145c031da0826e1d0fd39107476
 SHA512:
-  metadata.gz: d2af13f0a73178b307f1a0a031773ec437b415946d3eca67d5c4beb74ad846c382b7c09f697b1001fe10f877785570a62630c7c0f5e060aa3715cdb4e415d4a6
-  data.tar.gz: 93516a66dea643bbad6e8ecd2cca0c2d6f949564f70897b0ebb19268b3451751f7f710d45f54bd08f68a4049c244a9828b5574d606676931267bb16b338a3ba5
+  metadata.gz: 691beafcc3b44dbba577d9f9a6df0648034175902c88ce73eccd801e7c8828440570e7238477a1a94a9cf84226f4088f8a49852d80ae33d090cb4a7792e6fa5f
+  data.tar.gz: ea13f123359361a924ac43c1c4a3c8de13314d1b084d46b8d18852a6cf7777f7316e59e76c6c3bc9165925a906a9a8bf9b7ce2014396f8f2062c152813a04d9c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roku_builder (3.10.1)
+    roku_builder (3.10.2)
       faraday (~> 0.9)
       faraday-digestauth (~> 0.2)
       git (~> 1.3)

data/README.md

@@ -30,6 +30,7 @@ The tool allows scripting of the following:
 
 Other tasks the tool can complete:
 
+ * Device navigation
  * Configuration Generation
  * Configuration Validation
  * Configuration Updating
@@ -82,6 +83,12 @@ configuration options:
  * key -> keyed_pkg: path to a pkg file that has been signed
  * key -> password: password for the signed pkg
 
+There is an optional "input_mappings" section that will allow you to override
+the default input mappings. In the section each key is a key press code. The
+value is a array with the desired command to run and a human readable key name.
+To see the key press code for a specific key the --navigate command can be run
+with the --debug option on to see a print out of all the keys pressed.
+
 
 #### Sideloading
 
@@ -254,10 +261,18 @@ You can delete the currently sideloaded app using the following command:
 
 You can use a differnt configuration file useing the following option:
 
-    & roku --delete --config <path>
+    $ roku --delete --config <path>
 
 This path will be expanded so you do not have to use the full path
 
+You can use your keyboard to control the roku by running the following command:
+
+    $ roku --navigate
+
+To see the key mapings you can run the following command:
+
+    $ roku --navigate -V
+
 ## Projects
 
 The project used in the above examples is a smart default. If you are in a

data/config.json.example

@@ -29,5 +29,33 @@
       "keyed_pkg": "<path/to/signed/package>",
       "password": "<password>"
     }
+  },
+  "input_mapping": {
+    "\\e[1~": [ "home", "Home" ],
+    "<": [ "rew", "<" ],
+    ">": [ "ff", ">" ],
+    "=": [ "play", "=" ],
+    "\r": [ "select", "Enter" ],
+    "\\e[D": [ "left", "Left Arrow" ],
+    "\\e[C": [ "right", "Right Arrow" ],
+    "\\e[B": [ "down", "Down Arrow" ],
+    "\\e[A": [ "up", "Up Arrow" ],
+    "\t": [ "back", "Tab" ],
+    "": [ "replay", "" ],
+    "*": [ "info", "*" ],
+    "\u007f": [ "backspace", "Backspace" ],
+    "?": [ "search", "?" ],
+    "\\e\r": [ "enter", "Alt + Enter" ],
+    "\\e[5~": [ "volumeup", "Page Up" ],
+    "\\e[6~": [ "volumedown", "Page Down" ],
+    "\\e[4~": [ "mute", "End" ],
+    "": [ "channeldown", "" ],
+    "": [ "channelup", "" ],
+    "": [ "tuner", "" ],
+    "": [ "hdmi1", "" ],
+    "": [ "hdmi2", "" ],
+    "": [ "hdmi3", "" ],
+    "": [ "hdmi4", "" ],
+    "": [ "avi", "" ]
   }
 }

data/lib/roku_builder/config_parser.rb

@@ -33,7 +33,7 @@ module RokuBuilder
       return [UNKNOWN_STAGE, nil, nil] unless stage
       setup_sideload_config(configs: configs, options: options)
       setup_package_config(config: config, configs: configs, options: options, stage: stage)
-      setup_simple_configs(configs: configs, options: options, logger: logger)
+      setup_simple_configs(config: config, configs: configs, options: options, logger: logger)
       return [SUCCESS, configs]
     end
 
@@ -212,7 +212,7 @@ module RokuBuilder
     # @param configs [Hash] The parsed configs hash
     # @param options [Hash] The options hash
     # @param logger [Logger] System logger
-    def self.setup_simple_configs(configs:, options:, logger:)
+    def self.setup_simple_configs(config:, configs:, options:, logger:)
       # Create Manifest Config
       configs[:manifest_config] = {
         root_dir: configs[:project_config][:directory]
@@ -227,6 +227,16 @@ module RokuBuilder
         configs[:monitor_config] = {type: options[:monitor].to_sym}
       end
       # Create Navigate Config
+      mappings = {}
+      if config[:input_mapping]
+        config[:input_mapping].each_pair {|key, value|
+          unless "".to_sym == key
+            key = key.to_s.sub(/\\e/, "\e").to_sym
+            mappings[key] = value
+          end
+        }
+      end
+      configs[:init_params][:navigator] = {mappings: mappings}
       if options[:navigate]
         commands = options[:navigate].split(/, */).map{|c| c.to_sym}
         configs[:navigate_config] = {commands: commands}

data/lib/roku_builder/config_validator.rb

@@ -22,6 +22,7 @@ module RokuBuilder
   PROJECT_STAGE_METHOD_BAD  = 18
   KEY_MISSING_PATH          = 19
   KEY_MISSING_PASSWORD      = 20
+  INVALID_MAPPING_INFO      = 21
 
   MISSING_STAGE_METHOD      = -1
 
@@ -56,6 +57,11 @@ module RokuBuilder
           validate_key(codes: codes, key: key_config)
         }
       end
+      if config[:input_mapping]
+        config[:input_mapping].each_value {|info|
+          validate_mapping(codes: codes, mapping: info)
+        }
+      end
       codes.uniq!
       codes.push(0) if codes.empty?
       codes
@@ -87,6 +93,7 @@ module RokuBuilder
         "A project as an invalid stage method.",
         "A key is missing its keyed package path.",
         "A key is missing its password.", #20
+        "A input mapping is invalid",
         #===============WARNINGS===============#
         "A project is missing its stage method."
       ]
@@ -172,6 +179,15 @@ module RokuBuilder
     end
     private_class_method :validate_key
 
+    def self.validate_mapping(codes:, mapping:)
+      errors=[
+        [INVALID_MAPPING_INFO, mapping.nil?],
+        [INVALID_MAPPING_INFO, (mapping.count != 2)]
+      ]
+      process_errors(codes: codes, errors: errors)
+    end
+    private_class_method :validate_mapping
+
     def self.process_errors(codes:, errors:)
       errors.each do |error|
         codes.push(error[0]) if error[1]

data/lib/roku_builder/navigator.rb

@@ -6,7 +6,7 @@ module RokuBuilder
   class Navigator < Util
 
     # Setup navigation commands
-    def init
+    def init(mappings:)
       @commands = {
         home: "Home",
         rew: "Rev",
@@ -36,64 +36,36 @@ module RokuBuilder
         avi: "InputAVI"
       }
 
-      @keys = {
-        "\e[1~": :home,
-        "<": :rew,
-        ">": :ff,
-        "=": :play,
-        "\\": :select,
-        "\e[D": :left,
-        "\e[C": :right,
-        "\e[B": :down,
-        "\e[A": :up,
-        "\t": :back,
-        "@": :replay,
-        "*": :info,
-        "\u007f": :backspace,
-        "?": :search,
-        "\r": :enter,
-        "\e[5~": :volumeup,
-        "\e[6~": :volumedown,
-        "\e[4~": :mute
-        #"": :channeldown,
-        #"": :channelup,
-        #"": :tuner,
-        #"": :hdmi1,
-        #"": :hdmi2,
-        #"": :hdmi3,
-        #"": :hdmi4,
-        #"": :avi,
+      @mappings = {
+        "\e[1~": [ "home", "Home" ],
+        "<": [ "rew", "<" ],
+        ">": [ "ff", ">" ],
+        "=": [ "play", "=" ],
+        "\r": [ "select", "Enter" ],
+        "\e[D": [ "left", "Left Arrow" ],
+        "\e[C": [ "right", "Right Arrow" ],
+        "\e[B": [ "down", "Down Arrow" ],
+        "\e[A": [ "up", "Up Arrow" ],
+        "\t": [ "back", "Tab" ],
+        #"": [ "replay", "" ],
+        "*": [ "info", "*" ],
+        "\u007f": [ "backspace", "Backspace" ],
+        "?": [ "search", "?" ],
+        "\e\r": [ "enter", "Alt + Enter" ],
+        "\e[5~": [ "volumeup", "Page Up" ],
+        "\e[6~": [ "volumedown", "Page Down" ],
+        "\e[4~": [ "mute", "End" ],
+        #"": [ "channeldown", "" ],
+        #"": [ "channelup", "" ],
+        #"": [ "tuner", "" ],
+        #"": [ "hdmi1", "" ],
+        #"": [ "hdmi2", "" ],
+        #"": [ "hdmi3", "" ],
+        #"": [ "hdmi4", "" ],
+        #"": [ "avi", "" ]
       }
 
-
-      @key_mappings = {
-        "Home": :home,
-        "<": :rew,
-        ">": :ff,
-        "=": :play,
-        "\\": :select,
-        "Left Arrow": :left,
-        "Right Arrow": :right,
-        "Down Arrow": :down,
-        "Up Arrow": :up,
-        "Tab": :back,
-        "@": :replay,
-        "*": :info,
-        "Backspace": :backspace,
-        "?": :search,
-        "Enter": :enter,
-        "Page Up": :volumeup,
-        "Page Down": :volumedown,
-        "End": :mute
-        #"": :channeldown,
-        #"": :channelup,
-        #"": :tuner,
-        #"": :hdmi1,
-        #"": :hdmi2,
-        #"": :hdmi3,
-        #"": :hdmi4,
-        #"": :avi,
-      }
+      @mappings.merge!(mappings)
 
       @screens = {
         platform: [:home, :home, :home, :home, :home, :ff, :play, :rew, :play, :ff],
@@ -149,8 +121,8 @@ module RokuBuilder
     def interactive
       running = true
       @logger.info("Key Mappings:")
-      @key_mappings.each_pair {|key, command|
-        @logger.info("#{key} -> #{@commands[command]}")
+      @mappings.each_value {|key|
+        @logger.info("#{key[1]} -> #{@commands[key[0].to_sym]}")
       }
       @logger.info("Control-C -> Exit")
       while running
@@ -160,8 +132,8 @@ module RokuBuilder
           running = false
         else
           Thread.new(char) {|char|
-            if @keys[char.to_sym] != nil
-              nav(commands:[@keys[char.to_sym]])
+            if @mappings[char.to_sym] != nil
+              nav(commands:[@mappings[char.to_sym][0].to_sym])
             elsif char.inspect.force_encoding("UTF-8").ascii_only?
               type(text: char)
             end

data/lib/roku_builder/version.rb

@@ -2,5 +2,5 @@
 
 module RokuBuilder
   # Version of the RokuBuilder Gem
-  VERSION = "3.10.1"
+  VERSION = "3.10.2"
 end

data/tests/roku_builder/config_parser_test.rb

@@ -126,7 +126,8 @@ class ConfigParserTest < Minitest::Test
 
   def test_deeplink_app_config
     args = {
-      configs: {project_config: {directory: "dir"}},
+      config: {},
+      configs: {project_config: {directory: "dir"}, init_params: {}},
       options: {deeplink: "a:b", app_id: "xxxxxx"},
       logger: Logger.new("/dev/null")
     }

data/tests/roku_builder/navigator_test.rb

@@ -43,7 +43,8 @@ class NavigatorTest < Minitest::Test
       ip: "111.222.333",
       user: "user",
       password: "password",
-      logger: Logger.new("/dev/null")
+      logger: Logger.new("/dev/null"),
+      init_params: {mappings: {}}
     }
     if success
       if type == :nav
@@ -87,7 +88,8 @@ class NavigatorTest < Minitest::Test
       ip: "111.222.333",
       user: "user",
       password: "password",
-      logger: logger
+      logger: logger,
+      init_params: {mappings: {}}
     }
     navigator = RokuBuilder::Navigator.new(**device_config)
 
@@ -109,7 +111,8 @@ class NavigatorTest < Minitest::Test
       ip: "111.222.333",
       user: "user",
       password: "password",
-      logger: logger
+      logger: logger,
+      init_params: {mappings: {}}
     }
     navigator = RokuBuilder::Navigator.new(**device_config)
 
@@ -124,7 +127,8 @@ class NavigatorTest < Minitest::Test
       ip: "111.222.333",
       user: "user",
       password: "password",
-      logger: logger
+      logger: logger,
+      init_params: {mappings: {}}
     }
     navigator = RokuBuilder::Navigator.new(**device_config)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roku_builder
 version: !ruby/object:Gem::Version
-  version: 3.10.1
+  version: 3.10.2
 platform: ruby
 authors:
 - greeneca
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2016-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip