roku_builder 3.12.7 → 3.12.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9176b4d991a50edd2f0e9011fd487052eccb9897
-  data.tar.gz: 46e51f45694d978e9f39f6a6772cb81580eaddfa
+  metadata.gz: 3a562753d6f0b7fb5e05b78835ac660754faddda
+  data.tar.gz: 3c4fbf513f28f9f1c59b5776497be3b9ea626f65
 SHA512:
-  metadata.gz: 83dae8e4eefc66c8a74b7d9c1cbc7ea4bff311c1933d690f1374ec197ddcf5d116ebe2e97a6d9f0fb8528a31ada834fd329abe127ed6731fce2a177c64a16646
-  data.tar.gz: 855e6e1ff0cf89a8f962f513828209425e5aa270928611f1f0a999dccfb68dcbd09a379b0f6b791b4d956f0ad1a94d730570a5deadee41aa7cbc186e7b49f80b
+  metadata.gz: a44be2123c1949593a9221855c8e7feb3b4df08d17c5ed4aa316de2c95d25b34e31ad165a947064dbf86c2d089379ce8005df2d899334ae20dffb87bbe9641ec
+  data.tar.gz: 55ca8895e575e0ffc84170920821430e03081c1388bc171310b920b9827f6676e0a6ae867e06e6b97e5afcf813977abfcb3a3d52ac4d280fe107a8f7686a5d78

data/CHANGELOG

@@ -1,3 +1,16 @@
+ = 3.12.8 =
+
+ - Always print password/path from genkey
+ - Update dependancies
+ - Update README
+
+ = 3.12.7 =
+
+ - Ensure in file/dir is expanded
+ - Ensure project dirs exist
+ - Ensure key file exist
+ - Fix bug with print
+
  = 3.12.6 =
 
  - Update dependancies

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    roku_builder (3.12.7)
-      faraday (~> 0.11)
+    roku_builder (3.12.8)
+      faraday (~> 0.12)
       faraday-digestauth (~> 0.2)
       git (~> 1.3)
       net-ping (~> 2.0)
@@ -22,7 +22,7 @@ GEM
       thor (~> 0.19.4)
       tins (~> 1.6)
     docile (1.1.5)
-    faraday (0.11.0)
+    faraday (0.12.0.1)
       multipart-post (>= 1.2, < 3)
     faraday-digestauth (0.2.1)
       faraday (~> 0.7)

data/README.md

@@ -115,16 +115,15 @@ with the --debug option on to see a print out of all the keys pressed.
 
 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.  Side-load your application onto a Roku device for testing.
 1.  Run the genkey utility to generate a key.  This key will sign packages. This step only needs to be done once.
-1.  Run the package utility to generate the package.
-1.  Download the package from the Roku device to your computer.
+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 project and
+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.
@@ -165,12 +164,8 @@ you are trying to run the command. The options are as follows:
       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. If using script staging then it will run the
-      configured stage script before sideloading and then run the unstage
-      script after. If using git staging it will stach any local changes,
-      switch to the configured branch, sideload, switch back to the previous
-      branch, and unstach changes. This is the only source option that you can
-      use when packaging.
+      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
@@ -181,6 +176,60 @@ you are trying to run the command. The options are as follows:
  * --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
 
@@ -219,13 +268,12 @@ also needed to sign a package when updating a channel.
 
 You can create a key by running the genkey command:
 
-    $ roku --genkey --debug
+    $ roku --genkey
 
 This will output the following data, all of which need to put in the `keys` section of `~/.roku_config.json`:
 
 *  `Keyed PKG`: This is the signing key, used to sign new and updated packages
 *  `Password`: Key's password
-*  `DevID`: The developer ID associated with the key.  Don't need to save this, but it is best practice to include this string in the signing keys filename
 
 #### Packaging
 

data/lib/roku_builder/keyer.rb

@@ -7,7 +7,7 @@ module RokuBuilder
 
     def genkey(out_file: nil)
       password, dev_id = generate_new_key()
-      @logger.info("Password: "+password)
+      @logger.unknown("Password: "+password)
       @logger.info("DevID: "+dev_id)
 
       unless out_file
@@ -28,7 +28,7 @@ module RokuBuilder
         @device_config.delete(:init_params)
         packager = Packager.new(**@device_config)
         packager.package(app_name_version: "key_"+dev_id, out_file: out_file, password: password)
-        @logger.info("Keyed PKG: "+out_file)
+        @logger.unknown("Keyed PKG: "+out_file)
       }
     end
 

data/lib/roku_builder/version.rb

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

data/roku_builder.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = "~> 2.3"
 
   spec.add_dependency "rubyzip",             "~> 1.2"
-  spec.add_dependency "faraday",             "~> 0.11"
+  spec.add_dependency "faraday",             "~> 0.12"
   spec.add_dependency "faraday-digestauth",  "~> 0.2"
   spec.add_dependency "git",                 "~> 1.3"
   spec.add_dependency "net-ping",            "~> 2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roku_builder
 version: !ruby/object:Gem::Version
-  version: 3.12.7
+  version: 3.12.8
 platform: ruby
 authors:
 - greeneca
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-31 00:00:00.000000000 Z
+date: 2017-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: faraday-digestauth
   requirement: !ruby/object:Gem::Requirement