roku_builder 3.13.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd32080b9b4c8246240b9aaf4a7a2dae7d0e18e9
-  data.tar.gz: 421453a021d14e16253702b07d8dfb356a750a2c
+  metadata.gz: 20601e921fb6a11cbb6bdba633e4aa54a3e94343
+  data.tar.gz: 66bb11a717dcac6324d27a930fb964edbab0057d
 SHA512:
-  metadata.gz: 70e119253bf7a0379f466070e0fd97e69d2c50c2f353d32cc7985e6e6a69841840674c831f0c1873c39920453d234dc0501b93218eb34c3fae541ad38ad36465
-  data.tar.gz: ee473164b0297a43f6034b25adb3e8d75e2dd275db33d2c3bf8fbd231cfb51720645569f0c2da1c96ef2f768a2cb67d53261c5f0342cbe2c79dca68375ed38fb
+  metadata.gz: 9d0e9288d2038d9c0b9d4b24f3d15bdfd02552f2c5c454edff8d9b6edb99855a56ffd1a182aaf7e12f7fa46047305e56ad20633ea268bb6f45e6bf829941bca5
+  data.tar.gz: 25d90e11fbfa33b52eeeb2300137c0f1b4d93afe421e228afbc32189035ab4184bb682c02726380198e19e3f0f86b05fd740171265a50f437c79297649f382d2

data/.travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - "2.3.0"
+  - "2.4.1"

data/CHANGELOG

@@ -1,3 +1,15 @@
+ = 4.0.0 =
+
+ - Code base refactor for maintianability
+ - Add plugin architecture
+ - Add more profiler commands
+ - Replaced --deeplink-options command with just --deeplink
+ - Added Webmock to simplify tests
+ - Add basic intergration tests
+ - Move majority of documentation to Wiki
+ - Update to run on ruby-2.4.1
+ - Update dependancies
+
  = 3.13.0 =
 
  - Windows combatability

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roku_builder (3.13.0)
+    roku_builder (4.0.0)
       faraday (~> 0.12)
       faraday-digestauth (~> 0.2)
       git (~> 1.3)
@@ -14,6 +14,8 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
     byebug (9.0.6)
     coderay (1.1.1)
     coveralls (0.8.21)
@@ -22,6 +24,8 @@ GEM
       term-ansicolor (~> 1.3)
       thor (~> 0.19.4)
       tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
     docile (1.1.5)
     faraday (0.12.1)
       multipart-post (>= 1.2, < 3)
@@ -46,29 +50,32 @@ GEM
     guard-minitest (2.4.6)
       guard-compat (~> 1.2)
       minitest (>= 3.0)
+    hashdiff (0.3.4)
     json (2.1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     lumberjack (1.0.12)
-    m (1.5.0)
+    m (1.5.1)
       method_source (>= 0.6.7)
       rake (>= 0.9.2.2)
     method_source (0.8.2)
-    mini_portile2 (2.1.0)
+    mini_portile2 (2.2.0)
     minitest (5.10.2)
     minitest-autotest (1.0.3)
       minitest-server (~> 1.0)
     minitest-server (1.0.4)
       minitest (~> 5.0)
+    minitest-utils (0.3.1)
+      minitest
     multipart-post (2.0.0)
     nenv (0.3.0)
     net-http-digest_auth (1.4.1)
     net-ping (2.0.1)
     net-telnet (0.1.1)
-    nokogiri (1.7.2)
-      mini_portile2 (~> 2.1.0)
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
@@ -76,23 +83,29 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
+    public_suffix (2.0.5)
     rake (12.0.0)
     rb-fsevent (0.9.8)
     rb-inotify (0.9.8)
       ffi (>= 0.5.0)
     ruby_dep (1.5.0)
     rubyzip (1.2.1)
+    safe_yaml (1.0.4)
     shellany (0.0.1)
     simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
+    simplecov-html (0.10.1)
     slop (3.6.0)
     term-ansicolor (1.6.0)
       tins (~> 1.0)
     thor (0.19.4)
     tins (1.14.0)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
     win32-security (0.5.0)
       ffi
       ffi-win32-extensions
@@ -111,10 +124,12 @@ DEPENDENCIES
   minitest (~> 5.10)
   minitest-autotest (~> 1.0)
   minitest-server (~> 1.0)
+  minitest-utils (~> 0.3)
   rake (~> 12.0)
   roku_builder!
   simplecov (~> 0.12)
+  webmock (~> 3.0)
   yard (~> 0.9)
 
 BUNDLED WITH
-   1.13.7
+   1.15.1

data/Guardfile

@@ -17,10 +17,10 @@
 #
 # and, you'll have to watch "config/Guardfile" instead of "Guardfile"
 
-
 guard :minitest do
   # with Minitest::Unit
   watch(%r{^test/roku_builder/(.*)\/?test_(.*)\.rb$})
-  watch(%r{^lib/roku_builder/(.*/)?([^/]+)\.rb$})     { |m| "test/roku_builder/#{m[1]}test_#{m[2]}.rb" }
-  watch(%r{^test/roku_builder/test_helper\.rb$})      { 'test/roku_builder' }
+  watch(%r{^lib/roku_builder.rb$}) { "test/roku_builder/test_roku_builder.rb" }
+  watch(%r{^lib/roku_builder/(.*/)?([^/]+)\.rb$}) { |m| "test/roku_builder/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/roku_builder/test_helper\.rb$}) { 'test/roku_builder' }
 end

data/README.md

@@ -6,35 +6,8 @@
 [![Coverage Status](https://coveralls.io/repos/github/ViacomInc/roku_builder/badge.svg?branch=master)](https://coveralls.io/github/ViacomInc/roku_builder?branch=master)
 [![Code Climate](https://codeclimate.com/github/ViacomInc/roku_builder/badges/gpa.svg)](https://codeclimate.com/github/ViacomInc/roku_builder)
 
-A tool to help with Roku Development. Assists with the following roku
-development tasks:
-
- * Sideloading
- * Packaging
- * Building
- * Testing
-   * Deeplink testing
-   * Intergration test scripting
- * Manifest Updating
- * App Deleteing
- * Package Inspection
- * Monitoring logs
- * Profile Scene Graph applications
-
-The tool allows scripting of the following:
-
- * Conroller inputs
- * Text Input
- * Screencaptures
- * Printing project information
-
-Other tasks the tool can complete:
-
- * Device navigation
- * Configuration Generation
- * Configuration Validation
- * Configuration Updating
-
+A tool to help with Roku Development. Assists with many development/deployment
+tasks. More information can be found in the [wiki](https://github.com/ViacomInc/roku_builder/wiki).
 
 ## Installation
 
@@ -42,390 +15,40 @@ Install it yourself with:
 
     $ gem install roku_builder
 
-## Usage
-
-#### Configuration
-
-The gem must have a configuration file. To generate this file you can run the
-following command:
-
-    $ roku --configure
-
-This will create the file '~/.roku_config.json' with a default configuration.
-Edit this file to add appropriate values. A configuration example with the
-minimum require fields can be found in this project called 'config.json.min'.
-The following are default configuration options:
-
-##### Top Level Configuration
-
- * devices: information for accessing devices
- * projects: this is a hash of project objects
- * keys: contains keys that will be used for signing packages
- * input_mapping: allows you to change key mappings for the intractive navigator
-
-##### Device Configuration
-
- * devices.default: id of the default device
- * devices.<device_id>.ip: ip address of the device
- * devices.<device_id>.user: dev username for the roku device
- * devices.<device_id>.password: dev password for the roku device
-
-##### Project Configuration
-
- * projects.default: the key for the default project
- * projects.parent_dir: optional directory path that all projects are relative
-    to
- * projects.<project_id>.parent: optional id of parent project to copy configs
-    from
- * projects.<project_id>.directory: full path of the git repository the houses
-    the roku app
- * projects.<project_id>.app_name: Name used when packaging the app
- * projects.<project_id>.stage_method: Which method to use for switching app
-    stages (git or script)
- * projects.<project_id>.stages: a hash of stage objects
- * projects.<project_id>.stages.<stage_id>.branch: name of the branch for the
-    given stage (if stage_method = git). If using stage_method = stage then
-    this can be removed.
- * projects.<project_id>.stages.<stage_id>.script: scripts to use to stage the
-    app (if stage_method = script). If using stage_method = git this can be
-    removed.
- * projects.<project_id>.stages.<stage_id>.script.stage: script run form the
-    app root directory to stage app
- * projects.<project_id>.stages.<stage_id>.script -> unstage: script run form
-    the app root directory to unstage app
- * projects.<project_id>.stages.<stage_id>.key: this can be a string referencing
-    a key in the keys section or a hash of options
- * projects.<project_id>.stages.<stage_id>.key.keyed_pkg: path to a pkg file
-    that has been signed
- * projects.<project_id>.stages.<stage_id>.key.password: password for the signed pkg
-
-##### Key Configuration
-
- * keys.key_dir: optional directory that all keys are relative to
- * keys.<key_id>.keyed_pkg: path to a pkg file that has been signed
- * keys.<key_id>.password: password for the signed pkg
-
-The "input_mappings" section is optional but 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.
-
-#### Basic steps for creating a Roku channel/application package
-
-Official docs for packaging an application can be found [in the sdk](https://sdkdocs.roku.com/display/sdkdoc/Packaging+Your+Application), however the basic steps are:
-
-1.  Run the genkey utility to generate a key.  This key will sign packages. This step only needs to be done once.
-1.  Add the key to your configuration file. This will also only need to be done once.
-1.  Run the package utility to generate package. This will create a .pkg file in /tmp.
-
-RokuBuilder makes running each of these steps easy, without needing to use the Roku device web interface or telnet.
-
-#### Projects and Stages
-
-The configuration for this gem allows you to define any number of projects and
-any number of stages for each project. It is intended that each app be defined
-as a project and then the stages for that project would allow you to define
-production/staging/etc. stages.
-
-There are two different ways that stages can be defined. You can use a script
-to define your stage. This gives you the greatest amount of freedom allowing
-you to setup your stage anyway you want. The other option is to use git
-staging. To do this you must have one branch for eash stage.
-
-The project used in the examples below is a smart default. If you are in a
-project directory then it will use that project. If you are not then it will
-use the defualt that you have defined in your config. You can define what
-project you want the command to be run on using the --project option:
-
-    $ roku -lw --project project1
-
-or:
-
-    $ roku -lw -P project1
-
-#### Commands and Sources
-
-There are several commands that require a source option to run properly. These
-include:
-
- * Sideload
- * Build
- * Package
- * Test
- * Key
-
-There are several source options that can be supplied to these commands. Which
-options you use will depend on the type of staging you are using and the app
-you are trying to run the command. The options are as follows:
-
- * --ref or -r
-   * This option only works with git type staging. It will allow you to run a
-      command on a specific git branch, tag, or referance.
- * --stage or -s
-   * This option will work with either git or script staging. It allows you to
-      sideload a specific stage. See below for more information. This is the
-      only source option that you can use when packaging.
- * --working or -w
-   * This option will work with git or script staging. It will use the project
-      configs to determine the directory to use but will not run any staging
-      method.
- * --current or -c
-   * This option will ignore any project configurattion and just us the entire
-      current directory.
- * --in or -I
-   * This option allows you to pass in a zip file of an already built app.
-
-#### Staging
-
-It is usually a good idea to have multiple versions of your roku app. For
-example you could have a production and staging version of your app. RokuBuilder
-allows for this by using stages. There are two methods of staging, git, or
-script.
-
-If you choose to stage via git then for each stage you will define a git branch
-or ref. While staging (like durning packaging) RokuBuilder will stash all
-changes, checkout the defined branch, complete the requested action, checkout
-the orginal branch, and pop stashed changes.
-
-If you choose to use script staging then for each stage you will define a
-script to run that will change the app directory approiatly for that stage.
-You may also optionally define an unstage script that will return the directory
-to a clean working state. The script can be anything that will run in the
-project directory.
-
-A script staging example would be if you have a shell script (stage.sh) that
-append a config url in your manifest. You would have a different url for each
-stage:
-
-    #! /bin/bash
-    if [ "production" = $1 ]; then
-      echo "url=https://prod.url.com" >> manifest
-    else
-      echo "url=https://staging.url.com" >> manifest
-    fi
-
-You could also have a script (unstage.sh) that removed that last line:
-
-    #! /bin/bash
-    mv manifest manifest.tmp
-    head -n -1 manifest.tmp > manifest
-    rm manifest.tmp
-
-In your config you could have the following two stages assuming that these
-scripts were in the project root directory:
-
-    "stages": {
-      "prod": {
-        "script": {"stage": "./stage.sh production", "unstage": "./unstage"}
-      }
-      "staging": {
-        "script": {"stage": "./stage.sh staging", "unstage": "./unstage"}
-      }
-    }
-
-This would allow you to use the following two commands:
-
-    $ roku -ls prod
-    $ roku -ls staging
-
-This would sideload the app with the approiate url in the manifest.
-
-#### Sideloading
-
-You can sideload an app directly to the device using this gem. The gem will
-zip all of the configured files and upload it to the device and the remove the
-zip. You can do so with the following commands:
-
-    $ roku --sideload --stage production
-
-or:
-
-    $ roku -ls production
-
-When sideoading you can use any of the source options approiate to your staging
-method.
-
-#### Building
-
-You can build an app to be sideloaded later or by someone else by using the
-following command:
-
-    $ roku --build --working
-
-or:
-
-    $ roku -bw
-
-When bulding you can use any of the source options approiate to your staging
-method except the --in option.
-
-#### Generating a key
-
-Before you can package a channel, you must [generate a key](https://sdkdocs.roku.com/display/sdkdoc/Packaging+Your+Application#PackagingYourApplication-RunthegenkeyUtility)
-that is used to sign the package. This key is used to sign a new package and is
-also needed to sign a package when updating a channel.
-
-You can create a key by running the genkey command:
-
-    $ roku --genkey
+## Quick Start Guide
 
-This will output the following data, all of which need to put in the `keys` section of `~/.roku_config.json`:
+### Sideloading
 
-*  `Keyed PKG`: This is the signing key, used to sign new and updated packages
-*  `Password`: Key's password
+To sideload example or tutoral, switch to correct directory and run:
 
-#### Packaging
+    $ roku -lc
 
-To package an app you need to have at least on stage set up in your
-configuration file that has a key. Once you have that setup then you can run
-the following:
+To sideload project, ensure [config](https://github.com/ViacomInc/roku_builder/wiki/Configuration#project-configuration) is setup and run:
 
-    $ roku --package --stage production
-
-or:
-
-    $ roku -ps production
-
-The package command will automatically [Rekey](https://github.com/rokudev/docs/blob/master/develop/guides/packaging.md#rekeying)
-your roku device before packaging the channel
-
-#### Monitoring Logs
-
-The tool has the ability to monitor the different development logs. You use
-the feature using the command --monitor and passing in the type of log you want
-to monitor. For example the following command will monitor the main
-brightscript log:
-
-    $ roku --monitor main
-
-or:
-    $ roku -m main
-
-or
-
-    $ roku --monitor
-
-The following are the options to be passed in as type:
-
- * main
- * sg (depricated)
- * task1 (depricated)
- * task2 (depricated)
- * task3 (depricated)
- * taskX (depricated)
- * profile
-
-If no option is passed in then main log is monitored.
-
-The tool connects to the roku via telnet and prints everything that it
-recieves. It will continue indefinatly unless it is stopped via Ctrl-c or
-entering "q".
-
-The monitor tool also includes command history and some tab completeion.
-
-#### Interactive Navigation
-
-The gem has the ability to capture keyboard input and send it to the roku as
-remote inputs. This can be done by running the following command:
-
-    $ roku --navigate
-
-Running in verbose mode will print out all of the key mappings avaiable. If you
-want to change these mappings you can do so via the input_mapping config values
-. To determine the codes needed to enter in the input_mapping config you can
-run the navigator in debug mode.
-
-#### Profiling Scene Graph
-
-The tool will help a little with profiling scenegraph applications. Running the
-following command will print a list of all of the currently created nodes
-types and how many of each are being created.
-
-    $ roku --profile stats
-
-If you want to see more information about each node you can monitor the
-profile log (See Monitoring Logs above) and enter the following command:
-
-    $ sgnodes all
-
-#### Testing
-
-There are a few tools that can be used for testing. The testing command will
-sideload the branch defined in the testing stage. It will then connect to the
-device via telnet and look for the following strings and prints everything
-inbetween them:
-
-Start delimiter: \*\*\*\*\* STARTING TESTS \*\*\*\*\*
-
-End delimiter: \*\*\*\*\* ENDING TESTS \*\*\*\*\*
-
-This is designed to be used with the brstest library. Ensure that if you use
-this that the app the prints out a sufficent number of lines after the tests
-are run otherwise it will just grab the test run from last time.
-
-Another tool for testing is the navigate command. You can use this to script
-navigation on the roku console. The command is used as follows:
-
-    $ roku --nav <command>
-
-The possible commands are as follows:
-
- * up
- * down
- * right
- * left
- * select
- * back
- * home
- * rew
- * ff
- * play
- * replay
-
-There is also a command that will allow you to send text to the roku. It is
-used as follows:
-
-    $ roku --type <text>
-
-#### Other Tools
-
-You can deeplink into your app using the following command:
-
-    $ roku --deeplink-options "a:b c:d"
+    $ roku -lw
 
 or
 
-    $ roku -o "a:b c:d"
-
-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 delete the currently sideloaded app using the following command:
+    $ roku -ls <stage>
 
-    $ roku --delete
+### Debugging
 
-You can use a differnt configuration file useing the following option:
+To monitor debug log and interact with debugger run:
 
-    $ roku --delete --config <path>
+    $ roku -m
 
-This path will be expanded so you do not have to use the full path
+### Packaging
 
-## Devices
+To package and app:
 
-In the examples above the device used is a smart default. It will use the
-default device defined in the configuration file. If that device is not online
-it will look start at the top and try each device until it findes an avaiable
-device. If you have multiple devices defined in your config then you can select
-a different one using the following option:
+  1. Generate a key (Once):
 
-    $ roku -lw --device device2
-
-or:
+    $ roku --genkey
 
-    $ roku -lw -D device2
+  1. Add key to (config)[https://github.com/ViacomInc/roku_builder/wiki/Configuration#key-configuration] (Once).
+  1. Package channel:
 
+    $ roku -ps <stage>
 
 ## Documentation
 
@@ -437,9 +60,10 @@ directory:
 
 ## Improvements
 
- * Allow start and end delimiter for tests to be configured
  * Fix file naming when building from a referance
- * Extend profiling
+ * Add configuration option for build_version format
+ * Check if keying with bad password
+ * Check if missing key config when required
 
 ## Contributing