roku_builder 3.13.0 → 4.0.0

data/lib/roku_builder/hash.rb

@@ -0,0 +1,8 @@
+# ********** Copyright 2016 Viacom, Inc. Apache 2.0 **********
+
+class ::Hash
+  def deep_merge(second)
+    merger = proc { |_key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2  }
+    self.merge(second, &merger)
+  end
+end

data/lib/roku_builder/manifest.rb

@@ -0,0 +1,121 @@
+# ********** Copyright Viacom, Inc. Apache 2.0 **********
+
+module RokuBuilder
+  class Manifest
+
+    def self.generate(config:, attributes:)
+      FileUtils.touch(File.join(config.parsed[:root_dir], "manifest"))
+      manifest = new(config: config)
+      manifest.update(attributes: default_params.merge(attributes))
+      manifest
+    end
+
+    def initialize(config:)
+      @config = config
+      @attributes = {}
+      check_for_manifest
+      read
+    end
+
+    def update(attributes:)
+      update_attributes(attributes)
+      write_file
+    end
+
+    def increment_build_version
+      build_version_parts = @attributes[:build_version].split(".")
+      if build_version_parts.length == 2
+        build_version_parts[0] = Time.now.strftime("%m%d%y")
+        build_version_parts[1] = build_version_parts[1].to_i + 1
+        @attributes[:build_version] = build_version_parts.join(".")
+      else
+        @attributes[:build_version] = build_version_parts[0].to_i + 1
+      end
+      write_file
+    end
+
+    def method_missing(method)
+      @attributes[method]
+    end
+
+    private
+
+    def read
+      process_folder = -> (path){
+        File.open(path, 'r') do |file|
+          read_attributes(file)
+        end
+      }
+      process_zip = -> (entry){
+        entry.get_input_stream do |file|
+          read_attributes(file)
+        end
+      }
+      process_manifest(process_folder, process_zip)
+    end
+
+    def read_attributes(file)
+      file.each_line do |line|
+        key, value = line.split("=")
+        key = key.chomp.to_sym
+        value.chomp! if value
+        @attributes[key] = value
+      end
+    end
+
+    def check_for_manifest
+      process_folder = -> (path) {
+        raise ManifestError, "Missing Manifest: #{path}" unless File.exist?(path)
+      }
+      process_zip = -> (entry) {
+          raise ManifestError, "Missing Manifest in #{root_dir}" unless entry
+      }
+      process_manifest(process_folder, process_zip)
+    end
+
+    def process_manifest(process_folder, process_zip)
+      root_dir = @config.root_dir
+      if File.directory?(root_dir)
+        path = File.join(root_dir, "manifest")
+        process_folder.call(path)
+      elsif File.extname(root_dir) == ".zip"
+        Zip::File.open(root_dir) do |zip_file|
+          entry = zip_file.glob("manifest").first
+          process_zip.call(entry)
+        end
+      end
+    end
+
+    def update_attributes(attributes)
+      @attributes.merge!(attributes)
+    end
+
+    def write_file
+      root_dir = @config.parsed[:root_dir]
+      raise ManifestError, "Cannot Update zipped manifest" if File.extname(root_dir) == ".zip"
+      path = File.join(root_dir, "manifest")
+      File.open(path, "w") do |file|
+        @attributes.each_pair do |key,value|
+          if value
+            file.puts "#{key}=#{value}"
+          else
+            file.puts key
+          end
+        end
+      end
+    end
+
+    def self.default_params
+      {
+        title: "Default Title",
+        major_version: 1,
+        minor_version: 0,
+        build_version: "010101.0001",
+        mm_icon_focus_fhd: "<insert fhd focus icon url>",
+        mm_icon_focus_hd: "<insert hd focus icon url>",
+        mm_icon_focus_sd: "<insert sd focus icon url>"
+      }
+    end
+  end
+end
+

data/lib/roku_builder/options.rb

@@ -2,10 +2,17 @@
 
 module RokuBuilder
   class Options < Hash
-    def initialize(options:)
-      merge!(options)
+    def initialize(options: nil)
       @logger = Logger.instance
-      validate
+      setup_plugin_commands
+      options ||= parse
+      merge!(options)
+    end
+
+    def validate
+      validate_commands
+      validate_sources
+      validate_deprivated
     end
 
     def command
@@ -17,7 +24,7 @@ module RokuBuilder
     end
 
     def source_command?
-      (source_commands & keys).count > 0
+      source_commands.include?(command)
     end
 
     def device_command?
@@ -30,11 +37,57 @@ module RokuBuilder
 
     private
 
-    def validate
-      validate_commands
-      validate_sources
-      validate_combinations
-      validate_deprivated
+    def setup_plugin_commands
+      RokuBuilder.plugins.each do |plugin|
+        plugin.commands.each do |command, attributes|
+          commands << command
+          [:device, :source, :exclude].each do |type|
+            if attributes[type]
+              send("#{type}_commands".to_sym) << command
+            end
+          end
+        end
+      end
+    end
+
+    def parse
+      options = {}
+      options[:config] = '~/.roku_config.json'
+      options[:update_manifest] = false
+      parser = OptionParser.new
+      parser.banner = "Usage: roku <command> [options]"
+      add_plugin_options(parser: parser, options:options)
+      validate_parser(parser: parser)
+      parser.parse!
+      options
+    end
+
+    def add_plugin_options(parser:, options:)
+      RokuBuilder.plugins.each do |plugin|
+        parser.separator ""
+        parser.separator "Options for #{plugin}:"
+        plugin.parse_options(parser: parser, options: options)
+      end
+    end
+
+    def validate_parser(parser:)
+      short = []
+      long = []
+      stack = parser.instance_variable_get(:@stack)
+      stack.each do |optionsList|
+        optionsList.each_option do |option|
+          if option.respond_to?(:short)
+            if short.include?(option.short.first)
+              raise ImplementationError, "Duplicate short option defined: #{option.short.first}"
+            end
+            short.push(option.short.first) if option.short.first
+            if long.include?(option.long.first)
+              raise ImplementationError, "Duplicate long option defined: #{option.long.first}"
+            end
+            long.push(option.long.first) if option.long.first
+          end
+        end
+      end
     end
 
     def validate_commands
@@ -51,16 +104,6 @@ module RokuBuilder
       end
     end
 
-    def validate_combinations
-      all_sources = keys & sources
-      if all_sources.include?(:current) and not (self[:build] or self[:sideload])
-        raise InvalidOptions, "Current source onle works for build or sideload"
-      end
-      if self[:in] and not self[:sideload]
-        raise InvalidOptions, "In source only works for sideloading"
-      end
-    end
-
     def validate_deprivated
       depricated = keys & depricated_options.keys
       if depricated.count > 0
@@ -73,41 +116,37 @@ module RokuBuilder
     # List of command options
     # @return [Array<Symbol>] List of command symbols that can be used in the options hash
     def commands
-      [:sideload, :package, :test, :deeplink,:configure, :validate, :delete,
-        :navigate, :navigator, :text, :build, :monitor, :update, :screencapture,
-        :key, :genkey, :screen, :screens, :applist, :print, :profile, :dostage,
-        :dounstage]
+      @commands ||= []
     end
 
     # List of depricated options
     # @return [Hash] Hash of depricated options and the warning message for each
     def depricated_options
-      {deeplink_depricated: "-L and --deeplink are depricated. Use -o or --deeplink-options." }
+      @depricated_options ||= {}
     end
 
     # List of source options
     # @return [Array<Symbol>] List of source symbols that can be used in the options hash
     def sources
-      [:ref, :set_stage, :working, :current, :in]
+      [:ref, :stage, :working, :current, :in]
     end
 
     # List of commands requiring a source option
     # @return [Array<Symbol>] List of command symbols that require a source in the options hash
     def source_commands
-      [:sideload, :package, :test, :build, :key, :update, :print]
+      @source_commands ||= []
     end
 
     # List of commands the activate the exclude files
     # @return [Array<Symbol] List of commands the will activate the exclude files lists
     def exclude_commands
-      [:build, :package]
+      @exclude_commands ||= []
     end
 
     # List of commands that require a device
     # @return [Array<Symbol>] List of commands that require a device
     def device_commands
-      [:sideload, :package, :test, :deeplink, :delete, :navigate, :navigator,
-        :text, :monitor, :screencapture, :applist, :profile, :key, :genkey ]
+      @device_commands ||= []
     end
   end
 end

data/lib/roku_builder/plugin.rb

@@ -0,0 +1,30 @@
+# ********** Copyright Viacom, Inc. Apache 2.0 **********
+
+module RokuBuilder
+
+  # Super class for modules
+  # This class defines a common initializer and allows subclasses
+  # to define their own secondary initializer
+  module Plugin
+
+    def commands
+      raise ImplementationError, "commands method not implemented in #{self}"
+      #[
+      #  {
+      #   name: :command_name,
+      #   device: true || false,
+      #   source: true || false,
+      #   exclude: true || false
+      #  }
+      #]
+    end
+
+    def parse_options(option_parser:, options:)
+      raise ImplementationError, "parse_options method not implemented"
+    end
+
+    def dependencies
+      []
+    end
+  end
+end

data/lib/roku_builder/plugins/core.rb

@@ -0,0 +1,117 @@
+# ********** Copyright Viacom, Inc. Apache 2.0 **********
+
+module RokuBuilder
+
+  class Core
+    extend Plugin
+
+    def self.commands
+      {
+        configure: {},
+        validate: {},
+        increment: {source: true, stage: true},
+        dostage: {source: true},
+        dounstage: {source: true}
+      }
+    end
+
+    def self.parse_options(parser:, options:)
+      parser.separator "Commands:"
+      parser.on("--configure", "Copy base configuration file to the --config location. Default: '~/.roku_config.json'") do
+        options[:configure] = true
+      end
+      parser.on("--validate", "Validate configuration") do
+        options[:validate] = true
+      end
+      parser.on("-u", "--update-manifest", "Increment manifest build version") do
+        options[:increment] = true
+      end
+      parser.on("--do-stage", "Run the stager. Used for scripting. Always run --do-unstage after") do
+        options[:dostage] = true
+      end
+      parser.on("--do-unstage", "Run the unstager. Used for scripting. Always run --do-script first") do
+        options[:dounstage] = true
+      end
+      parser.separator ""
+      parser.separator "Config Options:"
+      parser.on("-e", "--edit PARAMS", "Edit config params when configuring. (eg. a:b, c:d,e:f)") do |p|
+        options[:edit_params] = p
+      end
+      parser.on("--config CONFIG", "Set a custom config file. Default: '~/.roku_config.json'") do |c|
+        options[:config] = c
+      end
+      parser.separator ""
+      parser.separator "Source Options:"
+      parser.on("-r", "--ref REF", "Git referance to use for sideloading") do |r|
+        options[:ref] = r
+      end
+      parser.on("-w", "--working", "Use working directory to sideload or test") do
+        options[:working] = true
+      end
+      parser.on("-c", "--current", "Use current directory to sideload or test. Overrides any project config") do
+        options[:current] = true
+      end
+      parser.on("-s", "--stage STAGE", "Set the stage to use. Default: 'production'") do |b|
+        options[:stage] = b
+      end
+      parser.on("-P", "--project ID", "Use a different project") do |p|
+        options[:project] = p
+      end
+      parser.separator ""
+      parser.separator "Other Options:"
+      parser.on("-O", "--out PATH", "Output file/folder. If PATH ends in .pkg/.zip/.jpg, file is assumed, otherwise folder is assumed") do |o|
+        options[:out] = o
+      end
+      parser.on("-I", "--in PATH", "Input file for sideloading") do |i|
+        options[:in] = i
+      end
+      parser.on("-D", "--device ID", "Use a different device corresponding to the given ID") do |d|
+        options[:device] = d
+        options[:device_given] = true
+      end
+      parser.on("-V", "--verbose", "Print Info message") do
+        options[:verbose] = true
+      end
+      parser.on("--debug", "Print Debug messages") do
+        options[:debug] = true
+      end
+      parser.on("-h", "--help", "Show this message") do
+        puts parser
+        exit
+      end
+      parser.on("-v", "--version", "Show version") do
+        puts RokuBuilder::VERSION
+        exit
+      end
+    end
+
+    def initialize(config:)
+      @config = config
+    end
+
+    def configure(options:)
+      # Stub command
+      # Handled in the config class
+      Logger.instance.unknown "Configured"
+    end
+    def validate(options:)
+      # Stub command
+      # Handled in the config class
+      Logger.instance.unknown "Config Validated"
+    end
+    def increment(options:)
+      manifest = Manifest.new(config: @config)
+      old = manifest.build_version
+      manifest.increment_build_version
+      new = manifest.build_version
+      Logger.instance.info "Update build version from:\n#{old}\nto:\n#{new}"
+    end
+    def dostage(options:)
+      Stager.new(config: @config, options: options).stage
+    end
+    def dounstage(options:)
+      Stager.new(config: @config, options: options).unstage
+    end
+  end
+  RokuBuilder.register_plugin(Core)
+end

data/lib/roku_builder/plugins/inspector.rb

@@ -0,0 +1,104 @@
+# ********** Copyright Viacom, Inc. Apache 2.0 **********
+
+module RokuBuilder
+
+  # Collects information on a package for submission
+  class Inspector < Util
+    extend Plugin
+
+    def self.commands
+      {
+        inspect: {device: true, source: true},
+        screencapture: {device: true}
+      }
+    end
+
+    def self.parse_options(parser:, options:)
+      parser.separator "Commands:"
+      parser.on("--inspect", "Print out information about a packaged app") do
+        options[:inspect] = true
+      end
+      parser.on("-S", "--screencapture", "Save a screencapture to the output file/folder") do
+        options[:screencapture] = true
+      end
+      parser.separator "Options:"
+      parser.on("--password PASSWORD", "Password used for inspect") do |p|
+        options[:password] = p
+      end
+    end
+
+    # Inspects the given pkg
+    def inspect(options:)
+      pkg = File.join(@config.in[:folder], @config.in[:file])
+      pkg = pkg+".pkg" unless pkg.end_with?(".pkg")
+      # upload new key with password
+      path = "/plugin_inspect"
+      conn = multipart_connection
+      payload =  {
+        mysubmit: "Inspect",
+        passwd: options[:password],
+        archive: Faraday::UploadIO.new(pkg, 'application/octet-stream')
+      }
+      response = conn.post path, payload
+
+      app_name = /App Name:\s*<\/td>\s*<td>\s*<font[^>]*>([^<]*)<\/font>\s*<\/td>/.match(response.body)
+      dev_id = nil
+      creation_date = nil
+      dev_zip = nil
+      if app_name
+        app_name = app_name[1]
+        dev_id = /Dev ID:\s*<\/td>\s*<td>\s*<font[^>]*>([^<]*)<\/font>\s*<\/td>/.match(response.body)[1]
+        creation_date = /new Date\(([^)]*)\)/.match(response.body.delete("\n"))[1]
+        dev_zip = /dev.zip:\s*<\/td>\s*<td>\s*<font[^>]*>([^<]*)<\/font>\s*<\/td>/.match(response.body)[1]
+      else
+        app_name = /App Name:[^<]*<div[^>]*>([^<]*)<\/div>/.match(response.body)[1]
+        dev_id = /Dev ID:[^<]*<div[^>]*><font[^>]*>([^<]*)<\/font><\/div>/.match(response.body)[1]
+        creation_date = /new Date\(([^\/]*)\)/.match(response.body.delete("\n"))[1]
+        dev_zip = /dev.zip:[^<]*<div[^>]*><font[^>]*>([^<]*)<\/font><\/div>/.match(response.body)[1]
+      end
+
+      info = {app_name: app_name, dev_id: dev_id, creation_date: Time.at(creation_date.to_i).to_s, dev_zip: dev_zip}
+
+      inspect_logger = ::Logger.new(STDOUT)
+      inspect_logger.formatter = proc {|_severity, _datetime, _progname, msg|
+        "%s\n\r" % [msg]
+      }
+      inspect_logger.unknown "=============================================================="
+      inspect_logger.unknown "App Name: #{info[:app_name]}"
+      inspect_logger.unknown "Dev ID: #{info[:dev_id]}"
+      inspect_logger.unknown "Creation Date: #{info[:creation_date]}"
+      inspect_logger.unknown "dev.zip: #{info[:dev_zip]}"
+      inspect_logger.unknown "=============================================================="
+
+    end
+
+    # Capture a screencapture for the currently sideloaded app
+    # @return [Boolean] Success
+    def screencapture(options:)
+      out = @config.out
+      payload =  {
+        mysubmit: "Screenshot",
+        passwd: @dev_password,
+        archive: Faraday::UploadIO.new(File::NULL, 'application/octet-stream')
+      }
+      response = multipart_connection.post "/plugin_inspect", payload
+
+      path = /<img src="([^"]*)">/.match(response.body)
+      raise ExecutionError, "Failed to capture screen" unless path
+      path = path[1]
+
+      unless out[:file]
+        out[:file] = /time=([^"]*)">/.match(response.body)
+        out[:file] = "dev_#{out[:file][1]}.jpg" if out[:file]
+      end
+
+      response = simple_connection.get path
+
+      File.open(File.join(out[:folder], out[:file]), "w") do |io|
+        io.write(response.body)
+      end
+      @logger.info "Screen captured to #{File.join(out[:folder], out[:file])}"
+    end
+  end
+  RokuBuilder.register_plugin(Inspector)
+end