roku_builder 3.4.4 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2edf88ef8bebe2d25296ac9df69d5e79f645051
-  data.tar.gz: bebb326f1be6f127139a7a707a89c748fe455766
+  metadata.gz: 01878e8347e002a0414b1bc0d3e21357cf9464ea
+  data.tar.gz: 693de68409f67d5c2139d3fa508db5206ae5979a
 SHA512:
-  metadata.gz: 670663b481d9f3c7a7a9d3504466b5b10e8ba1f6b8390ad2639345b80e09f1379d02897186d76751450cdb65c8e0e6b2fde55a41d22a8884727b5874dbf92aaa
-  data.tar.gz: 5aa407111a3c2cd822b9a19205dd55b0635985e29a8ed4c7348fe9a61a7519791c1e8e7cd36a058854e9a9614480e78aa74e8a22e289639df0e325855749b394
+  metadata.gz: 63e7b063e4d4e89a916f2a8c6f107a4b6dc3a7eacdb5e9169a9e9a2b9c3d0d98ef729692731449fa6335bda460e3fea294f80ccf21c192b7743bbb981f3bb707
+  data.tar.gz: b3f570b04987f9dc83bb8342f953b49d4ce315bb2a2598be25931cf2db7eed40c129ab2d08266b147dede2bccdc859b01ba64844a0a78dc4f07fa10995dfb21b

data/Gemfile.lock

@@ -1,17 +1,18 @@
 PATH
   remote: .
   specs:
-    roku_builder (3.4.4)
+    roku_builder (3.5.0)
       faraday (~> 0.9)
       faraday-digestauth (~> 0.2)
       git (~> 1.3)
       net-ping (~> 1.7)
+      net-telnet (~> 0.1)
       rubyzip (~> 1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    byebug (8.2.4)
+    byebug (9.0.0)
     coderay (1.1.1)
     coveralls (0.8.13)
       json (~> 1.8)
@@ -49,21 +50,23 @@ GEM
       multi_json (~> 1.8)
     http_parser.rb (0.6.0)
     json (1.8.3)
-    listen (3.0.6)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9.7)
+    listen (3.1.4)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
     lumberjack (1.0.10)
     method_source (0.8.2)
     minitest (5.8.4)
-    minitest-autotest (1.0.2)
+    minitest-autotest (1.0.3)
       minitest-server (~> 1.0)
-    minitest-server (1.0.3)
+    minitest-server (1.0.4)
       minitest (~> 5.0)
-    multi_json (1.11.2)
+    multi_json (1.12.0)
     multipart-post (2.0.0)
     nenv (0.3.0)
     net-http-digest_auth (1.4)
     net-ping (1.7.8)
+    net-telnet (0.1.1)
     notiffany (0.0.8)
       nenv (~> 0.1)
       shellany (~> 0.0)
@@ -75,6 +78,7 @@ GEM
     rb-fsevent (0.9.7)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
+    ruby_dep (1.3.1)
     rubyzip (1.2.0)
     shellany (0.0.1)
     simplecov (0.11.2)
@@ -94,7 +98,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.7)
-  byebug (~> 8.2)
+  byebug (~> 9.0)
   coveralls (~> 0.8)
   guard-livereload (~> 2.5)
   minitest (~> 5.8)
@@ -104,3 +108,6 @@ DEPENDENCIES
   roku_builder!
   simplecov (~> 0.11)
   yard (~> 0.8.7)
+
+BUNDLED WITH
+   1.12.3

data/README.md

@@ -220,16 +220,21 @@ used as follows:
 
 #### Other Tools
 
-You can restart the roku device using the following command:
+You can deeplink into your app using the following command:
 
-    $ roku --restart
+    $ roku --deeplink-options "a:b c:d"
 
-You can deeplink into your app using the following command:
+or
 
-    $ roku --deeplink --mgid <mgid> --content-type <content type>
+    $ roku -o "a:b c:d"
 
-This is currently setup to work with one specific app. It will be generalized
-in the future.
+This will deeplink into the app sending the keypair values as defined in the
+string. You can also have the app sideloaded first by adding one of the
+source options (--working/-w, --current/-c, --ref/-r, or --stage/-s).
+
+You can restart the roku device using the following command:
+
+    $ roku --restart
 
 You can delete the currently sideloaded app using the following command:
 
@@ -298,6 +303,7 @@ directory:
    * Intergration Tests
  * Move RokuBuilder::Controller to RokuBuilder?
  * Allow start and end delimiter for tests to be configured
+ * Fix fgile naming when building from a referance
 
 ## Contributing
 

data/bin/roku

@@ -27,8 +27,12 @@ OptionParser.new do |opts|
     options[:test] = true
   end
 
-  opts.on("-L", "--deeplink", "Command: Deeplink into app. Requires mgid and type options.") do
-    options[:deeplink] = true
+  opts.on("-L", "--deeplink", "Depricated: Deeplink now just requires -o or --deeplink-options") do
+    options[:deeplink_depricated] = true
+  end
+
+  opts.on("-o", "--deeplink-options OPTIONS", "Command: Deeplink into app. Define options as keypairs. (eg. a:b, c:d,e:f)") do |o|
+    options[:deeplink] = o
   end
 
   opts.on("--configure", "Command: Copy base configuration file to the --config location. Default: '~/.roku_config.json'") do
@@ -104,10 +108,6 @@ OptionParser.new do |opts|
     options[:inspect] = true
   end
 
-  opts.on("-o", "--deeplink-options TYPE", "Additional deeplink options. (eg. a:b, c:d,e:f)") do |o|
-    options[:deeplink_options] = o
-  end
-
   opts.on("-e", "--edit PARAMS", "Edit config params when configuring. (eg. a:b, c:d,e:f)") do |p|
     options[:edit_params] = p
   end

data/lib/roku_builder.rb

@@ -61,11 +61,14 @@ module RokuBuilder
   BAD_CURRENT     = 5
 
   # No deeplink options supplied for deeplink
-  BAD_DEEPLINK    = 6
+  # BAD_DEEPLINK    = 6
 
   # Incorrect use of the in option
   BAD_IN_FILE     = 7
 
+  # An Option is Depricated
+  DEPRICATED      = 8
+
 
 
   ### Device Codes ###

data/lib/roku_builder/config_parser.rb

@@ -194,7 +194,7 @@ module RokuBuilder
         root_dir: configs[:project_config][:directory]
       }
       # Create Deeplink Config
-      configs[:deeplink_config] ={options: options[:deeplink_options]}
+      configs[:deeplink_config] ={options: options[:deeplink]}
       # Create Monitor Config
       if options[:monitor]
         configs[:monitor_config] = {type: options[:monitor].to_sym}

data/lib/roku_builder/controller.rb

@@ -20,7 +20,7 @@ module RokuBuilder
 
       # Validate Options
       options_code = validate_options(options: options)
-      ErrorHandler.handle_options_codes(options_code: options_code, logger: logger)
+      ErrorHandler.handle_options_codes(options_code: options_code, options: options, logger: logger)
 
       # Configure Gem
       configure_code = configure(options: options, logger: logger)
@@ -48,7 +48,8 @@ module RokuBuilder
       source_result = validate_source_options(options: options)
       return source_result unless source_result == VALID
       combination_result = validate_option_combinations(options: options)
-      return combination_result
+      return combination_result unless combination_result == VALID
+      return validate_depricated_commands(options: options)
     end
     private_class_method :validate_options
 
@@ -87,13 +88,22 @@ module RokuBuilder
       if options[:in]
         return BAD_IN_FILE unless options[:sideload]
       end
-      if options[:deeplink]
-        return BAD_DEEPLINK if options[:deeplink_options].to_s.empty?
-      end
       VALID
     end
     private_class_method :validate_option_combinations
 
+    # Validate depricated options adn commands
+    # @param options [Hash] The Options hash
+    # @return [Integer] Status code for command validation
+    def self.validate_depricated_commands(options:)
+      depricated = options.keys & depricated_options.keys
+      if depricated.count > 0
+        return DEPRICATED
+      end
+      VALID
+    end
+    private_class_method :validate_depricated_commands
+
     # Run commands
     # @param options [Hash] The options hash
     # @return [Integer] Return code for options handeling
@@ -103,6 +113,7 @@ module RokuBuilder
       if ControllerCommands.simple_commands.keys.include?(command)
         params = ControllerCommands.simple_commands[command]
         params[:configs] = configs
+        params[:logger] = logger
         ControllerCommands.simple_command(**params)
       else
         params = ControllerCommands.method(command.to_s).parameters.collect{|a|a[1]}
@@ -155,12 +166,17 @@ module RokuBuilder
     end
     private_class_method :commands
 
+    # List of depricated options
+    # @return [Hash] Hash of depricated options and the warning message for each
+    def self.depricated_options
+      {deeplink_depricated: "-L and --deeplink are depricated. Use -o -r --deeplink-options." }
+    end
+
     # List of source options
     # @return [Array<Symbol>] List of source symbols that can be used in the options hash
     def self.sources
       [:ref, :set_stage, :working, :current]
     end
-    private_class_method :sources
 
     # List of commands requiring a source option
     # @return [Array<Symbol>] List of command symbols that require a source in the options hash

data/lib/roku_builder/controller_commands.rb

@@ -8,8 +8,6 @@ module RokuBuilder
     # @return [Hash] options to run simple commands
     def self.simple_commands
       {
-        deeplink: { klass: Linker, method: :link, config_key: :deeplink_config,
-          failure: FAILED_DEEPLINKING },
         delete: { klass: Loader, method: :unload },
         monitor: { klass: Monitor, method: :monitor,
           config_key: :monitor_config },
@@ -26,8 +24,10 @@ module RokuBuilder
       }
     end
     # Validate Config
+    # @param logger [Logger] system logger
     # @return [Integer] Success or Failure Code
-    def self.validate()
+    def self.validate(logger:)
+      logger.info "Config validated"
       SUCCESS
     end
     # Run Sideload
@@ -46,6 +46,7 @@ module RokuBuilder
       end
       stager.unstage
       return FAILED_SIDELOAD unless success
+      logger.info "App Sideloaded; staged using #{stager.method}"
       SUCCESS
     end
     # Run Package
@@ -85,6 +86,7 @@ module RokuBuilder
         end
       end
       stager.unstage
+      logger.info "App Packaged; staged using #{stager.method}"
       SUCCESS
     end
     # Run Build
@@ -106,6 +108,7 @@ module RokuBuilder
         logger.info "Build: #{outfile}"
       end
       stager.unstage
+      logger.info "App build; staged using #{stager.method}"
       SUCCESS
     end
     # Run update
@@ -124,14 +127,34 @@ module RokuBuilder
       SUCCESS
     end
 
+    # Run Deeplink
+    # @param options [Hash] user options
+    # @param configs [Hash] parsed configs
+    # @param logger [Logger] system logger
+    def self.deeplink(options:, configs:, logger:)
+      sources = options.keys & Controller.sources
+      if sources.count > 0
+        sideload(options: options, configs: configs, logger:logger)
+      end
+
+      linker = Linker.new(configs[:device_config])
+      if linker.link(configs[:deeplink_config])
+        logger.info "Deeplinked into app"
+        return SUCCESS
+      else
+        return FAILED_DEEPLINKING
+      end
+    end
+
     # Run a simple command
     # @param klass [Class] class of object to create
     # @param method [Symbol] methog to run on klass
     # @param config_key [Symbol] config to send from configs if not nil
     # @param configs [Hash] parsed roku config
     # @param failure [Integer] failure code to return on failure if not nil
+    # @param logger [Logger] system logger
     # @return [Integer] Success of failure code
-    def self.simple_command(klass:, method:, config_key: nil, configs:, failure: nil)
+    def self.simple_command(klass:, method:, config_key: nil, configs:, failure: nil, logger:)
       config = configs[:device_config].dup
       key = klass.to_s.split("::")[-1].underscore.to_sym
       if configs[:init_params][key]
@@ -144,6 +167,7 @@ module RokuBuilder
         success = instance.send(method)
       end
       return failure unless failure.nil? or success
+      logger.info ()
       SUCCESS
     end
   end

data/lib/roku_builder/error_handler.rb

@@ -5,7 +5,7 @@ module RokuBuilder
     # Handle codes returned from validating options
     # @param options_code [Integer] the error code returned by validate_options
     # @param logger [Logger] system logger
-    def self.handle_options_codes(options_code:, logger:)
+    def self.handle_options_codes(options_code:, options:, logger:)
       case options_code
       when EXTRA_COMMANDS
         logger.fatal "Only one command is allowed"
@@ -22,12 +22,11 @@ module RokuBuilder
       when BAD_CURRENT
         logger.fatal "Can only sideload or build 'current' directory"
         abort
-      when BAD_DEEPLINK
-        logger.fatal "Must supply deeplinking options when deeplinking"
-        abort
       when BAD_IN_FILE
         logger.fatal "Can only supply in file for building"
         abort
+      when DEPRICATED
+        print_options_depricateions(options: options, logger: logger)
       end
     end
 
@@ -112,5 +111,16 @@ module RokuBuilder
         abort
       end
     end
+
+    # Print Options Deprications
+    # @param options [Hash] The options hash.
+    # @param logger [Logger] system logger
+    def self.print_options_depricateions(options:, logger:)
+      depricated = Controller.depricated_options.keys & options.keys
+      depricated.each do |key|
+        logger.warn Controller.depricated_options[key]
+      end
+    end
+    private_class_method :print_options_depricateions
   end
 end

data/lib/roku_builder/stager.rb

@@ -12,6 +12,15 @@ module RokuBuilder
       @orginal_directory = Dir.pwd
     end
 
+    # Helper method to get the staging method being used
+    # @return [Symbol] staging method being used
+    def method
+      @method
+    end
+
+
+    # Change the stage of the app depending on the method
+    # @return [Boolean] whether the staging was successful or not
     def stage
       Dir.chdir(@root_dir) unless @root_dir == @orginal_directory
       case @method
@@ -32,6 +41,8 @@ module RokuBuilder
       @stage_success
     end
 
+    # Revert the change that the stage method made
+    # @return [Boolean] whether the revert was successful or not
     def unstage
       unstage_success = true
       case @method
@@ -56,6 +67,7 @@ module RokuBuilder
     private
 
     # Switch to the correct branch
+    # @param branch [String] the branch to switch to
     def git_switch_to(branch:)
       if branch
         @git ||= Git.open(@root_dir)
@@ -68,6 +80,8 @@ module RokuBuilder
     end
 
     # Switch back to the previous branch
+    # @param branch [String] teh branch to switch from
+    # @param checkout [Boolean] whether to actually run the checkout command
     def git_switch_from(branch:, checkout: true)
       if branch
         @git ||= Git.open(@root_dir)

data/lib/roku_builder/version.rb

@@ -1,4 +1,4 @@
 module RokuBuilder
   # Version of the RokuBuilder Gem
-  VERSION = "3.4.4"
+  VERSION = "3.5.0"
 end

data/roku_builder.gemspec

@@ -25,10 +25,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday-digestauth",  "~> 0.2"
   spec.add_dependency "git",                 "~> 1.3"
   spec.add_dependency "net-ping",            "~> 1.7"
+  spec.add_dependency "net-telnet",          "~> 0.1"
 
   spec.add_development_dependency "bundler",           "~> 1.7"
   spec.add_development_dependency "rake",              "~> 11.1"
-  spec.add_development_dependency "byebug",            "~> 8.2"
+  spec.add_development_dependency "byebug",            "~> 9.0"
   spec.add_development_dependency "minitest",          "~> 5.8"
   spec.add_development_dependency "minitest-autotest", "~> 1.0"
   spec.add_development_dependency "minitest-server",   "~> 1.0"

data/tests/roku_builder/controller_commands_test.rb

@@ -14,6 +14,7 @@ class ControllerCommandsTest < Minitest::Test
     loader.expect(:sideload, true, [configs[:sideload_config]])
     stager.expect(:stage, true)
     stager.expect(:unstage, true)
+    stager.expect(:method, :git)
 
     RokuBuilder::Loader.stub(:new, loader) do
       RokuBuilder::Stager.stub(:new, stager) do
@@ -57,6 +58,7 @@ class ControllerCommandsTest < Minitest::Test
     inspector.expect(:inspect, info, [configs[:inspect_config]])
     stager.expect(:stage, true)
     stager.expect(:unstage, true)
+    stager.expect(:method, :git)
 
     code = nil
     RokuBuilder::Keyer.stub(:new, keyer) do
@@ -98,6 +100,7 @@ class ControllerCommandsTest < Minitest::Test
     inspector.expect(:inspect, info, [configs[:inspect_config]])
     stager.expect(:stage, true)
     stager.expect(:unstage, true)
+    stager.expect(:method, :git)
 
     code = nil
     RokuBuilder::Keyer.stub(:new, keyer) do
@@ -132,6 +135,7 @@ class ControllerCommandsTest < Minitest::Test
     loader.expect(:build, "/tmp/build", [configs[:build_config]])
     stager.expect(:stage, true)
     stager.expect(:unstage, true)
+    stager.expect(:method, :git)
 
     RokuBuilder::Loader.stub(:new, loader) do
       RokuBuilder::ManifestManager.stub(:build_version, "1") do

data/tests/roku_builder/controller_test.rb

@@ -30,14 +30,10 @@ class ControllerTest < Minitest::Test
     }
     assert_equal RokuBuilder::BAD_CURRENT, RokuBuilder::Controller.send(:validate_options, {options: options})
     options = {
-      deeplink: true
+      deeplink: "a:b c:d",
+      deeplink_depricated: true
     }
-    assert_equal RokuBuilder::BAD_DEEPLINK, RokuBuilder::Controller.send(:validate_options, {options: options})
-    options = {
-      deeplink: true,
-      deeplink_options: ""
-    }
-    assert_equal RokuBuilder::BAD_DEEPLINK, RokuBuilder::Controller.send(:validate_options, {options: options})
+    assert_equal RokuBuilder::DEPRICATED, RokuBuilder::Controller.send(:validate_options, {options: options})
     options = {
       sideload: true,
       in: "",

data/tests/roku_builder/error_handler_test.rb

@@ -18,7 +18,6 @@ class ErrorHandlerTest < Minitest::Test
           RokuBuilder::EXTRA_SOURCES,
           RokuBuilder::NO_SOURCE,
           RokuBuilder::BAD_CURRENT,
-          RokuBuilder::BAD_DEEPLINK,
           RokuBuilder::BAD_IN_FILE
         ],
         configure_code:[
@@ -55,6 +54,9 @@ class ErrorHandlerTest < Minitest::Test
       warn: {
         load_code: [
           RokuBuilder::DEPRICATED_CONFIG
+        ],
+        options_code: [
+          RokuBuilder::DEPRICATED
         ]
       }
     }
@@ -63,7 +65,7 @@ class ErrorHandlerTest < Minitest::Test
         value.each do |code|
           logger = Minitest::Mock.new
           options = {logger: logger}
-          options[:options] = {} if key == :load_code
+          options[:options] = {deeplink_depricated: true} if key == :load_code or key == :options_code
           options[key] = code
           logger.expect(type, nil)  {|string| string.class == String}
           method = "handle_#{key}s"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roku_builder
 version: !ruby/object:Gem::Version
-  version: 3.4.4
+  version: 3.5.0
 platform: ruby
 authors:
 - greeneca
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-21 00:00:00.000000000 Z
+date: 2016-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: net-telnet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.2'
+        version: '9.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.2'
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement