roku_builder 3.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4fb0f1a154541f38d45f4cec4a78800d5442c4de
+  data.tar.gz: 04f1448deacf24c15223993745750f9298b6107a
+SHA512:
+  metadata.gz: 40eb84586c9745d4faac4eae184c02be437966d65f71e194d0befb18c78e98e4f73a3fce23ab755ea5721242c928dec6462dea5969c75bd890da8933be0f054d
+  data.tar.gz: 0370b82f8bf8d258f2c9ab04b88b4624e73129dd01db3e38cc97a1c15e123a7b2064a9e4820d63b3662fb8f2ca6bf24c1b6d2eb13745829cf7add45acec3ae77

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+doc
+.yardoc
+coverage

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in roku_builder.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    roku_builder (3.3.1)
+      faraday (~> 0.9)
+      faraday-digestauth (~> 0.2)
+      git (~> 1.2.9)
+      net-ping (~> 1.7)
+      rubyzip (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (3.5.1)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+      slop (~> 3.6)
+    coderay (1.1.0)
+    columnize (0.9.0)
+    debugger-linecache (1.2.0)
+    docile (1.1.5)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.0.9.1)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday-digestauth (0.2.1)
+      faraday (~> 0.7)
+      net-http-digest_auth (~> 1.4)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    git (1.2.9.1)
+    guard (2.13.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-livereload (2.5.2)
+      em-websocket (~> 0.5)
+      guard (~> 2.8)
+      guard-compat (~> 1.0)
+      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)
+    lumberjack (1.0.10)
+    method_source (0.8.2)
+    minitest (5.8.4)
+    minitest-autotest (1.0.2)
+      minitest-server (~> 1.0)
+    minitest-server (1.0.3)
+      minitest (~> 5.0)
+    multi_json (1.11.2)
+    multipart-post (2.0.0)
+    nenv (0.3.0)
+    net-http-digest_auth (1.4)
+    net-ping (1.7.8)
+    notiffany (0.0.8)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rubyzip (1.1.7)
+    shellany (0.0.1)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    thor (0.19.1)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  byebug (~> 3.5)
+  guard-livereload (~> 2.5)
+  minitest (~> 5.8)
+  minitest-autotest (~> 1.0)
+  minitest-server (~> 1.0)
+  rake (~> 10.0)
+  roku_builder!
+  simplecov (~> 0.11)
+  yard (~> 0.8.7)

data/Guardfile

@@ -0,0 +1,21 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard 'livereload' do
+  watch(%r{lib/roku_builder/.+\.rb})
+  watch(%r{lib/roku_builder.rb})
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Viacom Inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,282 @@
+# RokuBuilder
+
+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
+
+The tool allows scripting of the following interactions with the roku:
+
+ * Conroller inputs
+ * Text Input
+ * Screencaptures
+
+Other tasks the tool can complete:
+
+ * Configuration Generation
+ * Configuration Validation
+ * Configuration Updating
+
+
+## Installation
+
+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. The following are default
+configuration options:
+
+ * devices: information for accessing devices
+ * devices -> default: id of the default device
+ * projects: this is a hash of project objects
+ * projects -> default: the key for the default project
+
+ Each Device has the following options:
+
+ * ip: ip address of the device
+ * user: dev username for the roku device
+ * password: dev password for the roku device
+
+ Each project has the following options:
+
+ * directory: full path of the git repository the houses the roku app
+ * app_name: Name used when packaging the app
+ * stages: a hash of stage objects
+
+ Each stage has the following options:
+
+ * branch: name of the branch for the given stage
+ * key: has of key options for signing a package
+ * key -> keyed_pkg: path to a pkg file that has been signed
+ * key -> password: password for the signed pkg
+
+
+#### Sideloading
+
+There are several ways to side load an app. You can sideload based on a stage,
+an arbitrary git referance or the working directory.
+
+To sideload a stage you can run the following command:
+
+    $ roku --sideload --stage production
+
+This will sideload the production stage. By default the production stage is
+used. So the above is equivalent to the following:
+
+    $ roku --sideload
+
+and:
+
+    $ roku -l
+
+To sideload via a git referance you can run the following command
+
+    $ roku --sideload --ref master
+
+This will sideload the master branch. The following is equivalent:
+
+    $ roku -lr master
+
+To sideload the current working directory you can run the following:
+
+    $ roku --sideload --working
+
+or:
+
+    $ roku -lw
+
+If you choose to sideload via stage or git referance then the roku tool with
+stash any changes in the working directory and then apply the stash after. From
+time to time there may be an issue with this and you will have to clear the
+stash manually.
+
+You can also sideload the current directory even if it is not setup as a
+project. If the directory has a manifest file then you can run the following
+command:
+
+    $ roku --sideload --current
+
+or:
+
+    $ roku -lc
+
+#### Packaging
+
+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:
+
+    $ roku --package --stage production
+
+or:
+
+    $ roku -ps production
+
+#### Building
+
+You can build an app to be sideloaded later or by someone else by using the
+following command:
+
+    $ roku --build --stage production
+
+or:
+
+    $ roku -bw
+
+
+#### 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
+
+The following are the options to be passed in as type:
+
+ * main
+ * sg
+ * task1
+ * task2
+ * task3
+ * taskX
+
+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".
+
+#### 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 --navigate <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 restart the roku device using the following command:
+
+    $ roku --restart
+
+You can deeplink into your app using the following command:
+
+    $ roku --deeplink --mgid <mgid> --content-type <content type>
+
+This is currently setup to work with one specific app. It will be generalized
+in the future.
+
+You can delete the currently sideloaded app using the following command:
+
+    $ roku --delete
+
+You can use a differnt configuration file useing the following option:
+
+    & roku --delete --config <path>
+
+This path will be expanded so you do not have to use the full path
+
+## Projects
+
+The project used in the above examples is a smart default. If you are in a
+project directory then it will use that project. If you 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
+
+## Devices
+
+In the examples above the default device is used. If you have multiple devices
+defined in your config then you can select a different one using the following
+option:
+
+    $ roku -lw --device device2
+
+or:
+
+    $ roku -lw -D device2
+
+
+## Documentation
+
+To generate the documentation run the following command in the project root
+directory:
+
+    $ yard doc --protected lib
+
+
+## Improvements
+
+ * Increase testing
+   * More Unit Tests
+   * Intergration Tests
+ * Move RokuBuilder::Controller to RokuBuilder?
+ * Allow start and end delimiter for tests to be configured
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create a new Pull Request