brookemckim / roku-packager

Ruby library for uploading and packaging Roku applications.

Roku Packager

Roku Packager is a ruby library for uploading and packaging Roku applications. Normally this interaction has to be done through the clunky Roku web GUI. Given an installer enabled Roku and a compiled zip of your code you can pass it to Roku Packager and it will return the url to download the pkg file that is ready for upload to roku.com.

Installation

Add this line to your application's Gemfile:

gem 'roku-packager'

And then execute:

$ bundle

Or install it yourself as:

$ gem install roku-packager

Usage

First you need a Roku in development mode on your network and a zip file of your Roku source file.

Then you can instansiate a client.

ip_of_your_roku = '192.168.0.10'
roku = RokuPackager.new(ip_of_your_roku)

# Pass in a logger for inside information.
roku = RokuPackager.new(ip_of_your_roku, Logger.new(STDOUT))

# This may take a couple minutes. Generating the keys is the slowest part.
roku.package('application_name', '/path/to/roku/app.zip')
# => http://192.168.0.10/pkg/app.pkg

You can then download this package with your tool of choice.

wget http://192.168.0.10/pkg/app.pkg

Each part of the process can be used as a standalone piece.

# Generate DevID and Password.
dev_id, password = RokuPackager::KeyGen.new(ip_of_your_roku).create

# Upload application zip.
RokuPackager::Uploader.new(ip_of_your_roku).run('/path/to/app.zip')

# Package an uploaded application.
download_uri = RokuPackager::Packager.new(ip_of_your_roku, 'application_name',
password).submit

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

roku-packager's Issues

Support for passing in password

Right now a new DevID and Password are generated every time an app is packaged. Add support for passing in an existing password.

This has two use cases

• Keep the password already on the Roku - this is already possible if you just use Uploader and Packager standalone.
• Update the Roku to the passed in Password

The second is more complicated because it requires an uploaded package that was created with the password you want to change the Roku to.

Add support for compiling zip file before sending to the device.

You can then pass in a directory instead of a .zip and roku-packager would run make.