web-ext-native-app-packer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '09c7d21d2f9ac671ad4e5e2b8b73be3ac1267fc3'
+  data.tar.gz: fcee4f7e4650138b70dc39fb715aebccaf7798a0
+SHA512:
+  metadata.gz: b2836d75eb7b1df1e45fa40799156b44241c8c500dda1dde5943e5c8bec9e2be911e5e3f314289595b263d98cf02e0ef0e8c669bb66f0479aec34f6574386f88
+  data.tar.gz: fcd3e01e7ba510a2d74587672695be4517de8b54cc5dbe2ebd6923b0ce0b010dd131793320558c4e548ad3c0758175421c43783dab52e028df2b896667752be1

data/README.md

@@ -0,0 +1,62 @@
+
+# web ext native app packer
+
+A tool to pack web extension native application.
+
+# usage
+
+1. install gem
+```shell
+gem install web-ext-native-app-packer
+```
+
+2. create pack.yaml in your native App directory
+```yaml
+app_name: 'awesome_app'
+app_description: 'description of awesome_app'
+app_path: 'main.rb'
+execute_cmd: 'ruby'
+# your web extension's firefox extension id
+extension_id: 'awesome_app@example.org'
+# your web extension's chrome extension origin (format => "chrome-extension://$id/")
+extension_origin: 'chrome-extension://abtwertkbasdftllwerwh/'
+```
+
+3. run pack command
+```shell
+# web-ext-native-app-packer $native-app-directory $output-dir
+web-ext-native-app-packer my-extension/native-app dist
+```
+
+
+# result
+```shell
+> tree ./dist
+./dist/
+├── awesome-app-linux-chrome.zip
+├── awesome-app-linux-chromium.zip
+├── awesome-app-linux-firefox.zip
+├── awesome-app-osx-chrome.zip
+├── awesome-app-osx-chromium.zip
+├── awesome-app-osx-firefox.zip
+├── awesome-app-windows-chrome.zip
+├── awesome-app-windows-chromium.zip
+└── awesome-app-windows-firefox.zip
+```
+
+It will generate some file to help extension user to Install(uninstall) native application
+
+```
+# Windows
+app_loader.bat  # load native application
+manifest.json   # native application's manifest file
+install.bat     # install script
+uninstall.bat   # uninstall script
+
+# Linux or OSX
+manifest.json   # native application's manifest file
+install.sh      # install script
+uninstall.sh    # uninstall script
+```
+
+

data/bin/web-ext-native-app-packer

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+def print_help
+  puts "Usage: web-ext-native-app-packer $native_app_dir $output_dir"
+end
+
+if ARGV.length != 2
+  print_help
+  exit 1
+end
+
+dir = ENV['PWD']
+project_dir, output_dir = ARGV
+project_dir = File.expand_path(project_dir, dir)
+output_dir = File.expand_path(output_dir, dir)
+
+def exit_if_not_exist(filename)
+  unless File.exist? filename
+    puts "Error: #{filename} not exist."
+    exit 1
+  end
+end
+
+exit_if_not_exist(project_dir)
+exit_if_not_exist(output_dir)
+
+yaml_path = File.join(project_dir, 'pack.yaml')
+exit_if_not_exist(yaml_path)
+
+require 'yaml'
+require 'ostruct'
+require File.expand_path('../../lib/web-ext-native-app-packer', __FILE__)
+
+yaml = YAML.load_file(yaml_path)
+input = OpenStruct.new(yaml)
+input.project_dir = project_dir
+input.output_dir = output_dir
+
+WebExtNativeAppPacker.perform(input)

data/lib/pack.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+input_path=$1
+output_path=$2
+
+cd $input_path
+zip -r $output_path *
+cd ..
+rm -rf $input_path

data/lib/template/app-loader.bat.erb

@@ -0,0 +1,3 @@
+@echo off
+
+<%= @v.execute_cmd %> "%~dp0/<%= @v.app_path %>" %*

data/lib/template/install-unix-like.sh.erb

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+APP_NAME="<%= @v.app_name %>"
+DIR=$(dirname $(realpath "$0"))
+
+# Chrome
+if [ "$(whoami)" = "root" ]; then
+  TARGET_DIR="<%= @v.target_path_system %>"
+else
+  TARGET_DIR="<%= @v.target_path_user %>"
+fi
+
+# create directory
+mkdir -p "$TARGET_DIR"
+
+# copy to manifest file to target dir
+cp "$DIR/manifest.json" "$TARGET_DIR/${APP_NAME}.json"
+
+# Update host path in the manifest.
+APP_PATH=$DIR/app.rb
+ESCAPED_APP_PATH=${APP_PATH////\\/}
+sed -i -e "s/APP_PATH/$ESCAPED_APP_PATH/" "$TARGET_DIR/$APP_NAME.json"
+
+# set permissions
+chmod o+r "$TARGET_DIR/${APP_NAME}.json"
+
+echo "[Chrome] Native messaging host $APP_NAME has been installed."

data/lib/template/install-windows.bat.erb

@@ -0,0 +1 @@
+REG ADD "<%= @v.target_path_user %>\<%= @v.app_name %>" /ve /t REG_SZ /d "%~dp0manifest.json" /f

data/lib/template/manifest.json.erb

@@ -0,0 +1,7 @@
+{
+  "name": "<%= @v.app_name %>",
+  "description": "<%= @v.app_description %>",
+  "path": "<%= @v.app_path %>",
+  "type": "stdio",
+  "<%= @v.white_list_key %>": [ "<%= @v.extension_identify %>" ]
+}

data/lib/template/uninstall-unix-like.sh.erb

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+APP_NAME="<%= @v.app_name %>"
+
+if [ "$(whoami)" = "root" ]; then
+  TARGET_DIR="<%= @v.target_path_system %>"
+else
+  TARGET_DIR="<%= @v.target_path_user %>"
+fi
+
+rm "$TARGET_DIR/${APP_NAME}.json"
+echo "Native messaging host $APP_NAME has been uninstalled."

data/lib/template/uninstall-windows.bat.erb

@@ -0,0 +1,2 @@
+REG DELETE "<%= @v.target_path_system %>\<%= @v.app_name %>" /f
+REG DELETE "<%= @v.target_path_user %>\<%= @v.app_name %>" /f

data/lib/web-ext-native-app-packer.rb

@@ -0,0 +1,224 @@
+
+require 'ostruct'
+
+module WebExtNativeAppPacker
+
+  TARGET_PATH_OSX = {
+    chrome: {
+      system: '/Library/Google/Chrome/NativeMessagingHosts',
+      user: '$HOME/Library/Application Support/Google/Chrome/NativeMessagingHosts'
+    },
+    chromium: {
+      system: '/Library/Application Support/Chromium/NativeMessagingHosts',
+      user: '$HOME/Library/Application Support/Chromium/NativeMessagingHosts'
+    },
+    firefox: {
+      system: '/Library/Application Support/Mozilla/NativeMessagingHosts',
+      user: '$HOME/Library/Application Support/Mozilla/NativeMessagingHosts'
+    }
+  }
+
+  TARGET_PATH_LINUX = {
+    chrome: {
+      system: '/etc/opt/chrome/native-messaging-hosts',
+      user: '$HOME/.config/google-chrome/NativeMessagingHosts'
+    },
+    chromium: {
+      system: '/etc/chromium/native-messaging-hosts',
+      user: '$HOME/.config/chromium/NativeMessagingHosts'
+    },
+    firefox: {
+      system: '/usr/lib64/mozilla/native-messaging-hosts',
+      user: '$HOME/.mozilla/native-messaging-hosts'
+    }
+  }
+
+  TARGET_PATH_WINDOWS = {
+    chrome: {
+      system: 'HKEY_LOCAL_MACHINE\SOFTWARE\Google\Chrome\NativeMessagingHosts',
+      user: 'HKEY_CURRENT_USER\SOFTWARE\Google\Chrome\NativeMessagingHosts'
+    },
+    chromium: {
+      system: 'HKEY_LOCAL_MACHINE\SOFTWARE\Google\Chrome\NativeMessagingHosts',
+      user: 'HKEY_CURRENT_USER\SOFTWARE\Google\Chrome\NativeMessagingHosts'
+    },
+    firefox: {
+      system: 'HKEY_LOCAL_MACHINE\SOFTWARE\Mozilla\NativeMessagingHosts',
+      user: 'HKEY_CURRENT_USER\SOFTWARE\Mozilla\NativeMessagingHosts'
+    }
+  }
+
+  def self.perform(input)
+    render_manifest(input)
+    render_app_loader(input)
+    render_unix_like_install_script(input)
+    render_unix_like_uninstall_script(input)
+    render_windows_install_script(input)
+    render_windows_uninstall_script(input)
+    copy_project_file(input)
+    zip_folds(input)
+  end
+
+  def self.copy_project_file(input)
+    input_path = File.join(input.project_dir, '*')
+    each_item do |platform, browser_name|
+      output_path = File.join(
+        input.output_dir,
+        [platform, browser_name].join('-'),
+      )
+      `cp -r #{input_path} #{output_path}`
+    end
+  end
+
+  def self.zip_folds(input)
+    each_item do |platform, browser_name|
+      name = input.app_name.gsub('_', '-').gsub('.', '-')
+      input_fold = File.join(
+        input.output_dir,
+        [platform, browser_name].join('-'),
+      )
+      archive_path = File.join(
+        input.output_dir,
+        [[name, platform, browser_name].join('-'), 'zip'].join('.')
+      )
+      pack_sh = File.expand_path('../pack.sh', __FILE__)
+      `#{pack_sh} #{input_fold} #{archive_path}`
+    end
+  end
+
+  def self.render_unix_like_install_script(input)
+    render_script(input,
+      erb_path: File.expand_path('../template/install-unix-like.sh.erb', __FILE__),
+      platforms: ['osx', 'linux'],
+      filename: 'install.sh')
+  end
+
+  def self.render_unix_like_uninstall_script(input)
+    render_script(input,
+      erb_path: File.expand_path('../template/uninstall-unix-like.sh.erb', __FILE__),
+      platforms: ['osx', 'linux'],
+      filename: 'uninstall.sh')
+  end
+
+  def self.render_windows_install_script(input)
+    render_script(input,
+      erb_path: File.expand_path('../template/install-windows.bat.erb', __FILE__),
+      platforms: ['windows'],
+      filename: 'install.bat')
+  end
+
+  def self.render_windows_uninstall_script(input)
+    render_script(input,
+      erb_path: File.expand_path('../template/uninstall-windows.bat.erb', __FILE__),
+      platforms: ['windows'],
+      filename: 'uninstall.bat')
+  end
+
+  def self.render_script(input, erb_path:, platforms:, filename:)
+    each_item do |platform, browser_name|
+      if platforms.include?(platform)
+        target_path = get_target_path(platform, browser_name)
+        v = OpenStruct.new({
+          app_name: input.app_name,
+          target_path_system: target_path[:system],
+          target_path_user: target_path[:user]
+        })
+        out_path = File.join(
+          input.output_dir,
+          [platform, browser_name].join('-'),
+          filename
+        )
+        Helper.render(v, erb_path, out_path)
+      end
+    end
+  end
+
+  def self.get_target_path(platform, browser_name)
+    dict = \
+      case platform
+      when 'osx'    then TARGET_PATH_OSX
+      when 'linux'  then TARGET_PATH_LINUX
+      when 'windows'then TARGET_PATH_WINDOWS
+      end
+    dict[browser_name.to_sym]
+  end
+
+
+  def self.render_app_loader(input)
+    erb_path = File.expand_path('../template/app-loader.bat.erb', __FILE__)
+    each_item do |platform, browser_name|
+      if platform == 'windows'
+        v = OpenStruct.new({
+          execute_cmd: input.execute_cmd,
+          app_path: input.app_path
+        })
+        out_path = File.join(
+          input.output_dir,
+          [platform, browser_name].join('-'),
+          'app_loader.bat'
+        )
+        Helper.render(v, erb_path, out_path)
+      end
+    end
+  end
+
+  def self.render_manifest(input)
+    erb_path = File.expand_path('../template/manifest.json.erb', __FILE__)
+    each_item do |platform, browser_name|
+      v = OpenStruct.new({
+        app_name: input.app_name,
+        app_description: input.app_description
+      })
+      if browser_name == 'firefox'
+        v.white_list_key = 'allowed_extensions'
+        v.extension_identify = input['extension_id']
+      else
+        v.white_list_key = 'allowed_origins'
+        v.extension_identify = input['extension_origin']
+      end
+
+      if platform == 'windows'
+        v.app_path = 'app_loader.bat'
+      else
+        v.app_path = 'APP_PATH'
+      end
+
+      out_path = File.join(
+        input.output_dir,
+        [platform, browser_name].join('-'),
+        'manifest.json'
+      )
+      Helper.render(v, erb_path, out_path)
+    end
+  end
+
+  def self.each_item
+    ['osx', 'linux', 'windows'].each do |platform|
+      ['chrome', 'chromium', 'firefox'].each do |browser_name|
+        yield platform, browser_name
+      end
+    end
+  end
+
+  module Helper
+    require 'erb'
+    require 'fileutils'
+    def self.render(v, erb_path, out_path)
+      mkdir(out_path)
+      @v = v
+      b = binding
+      erb = ::ERB.new(File.new(erb_path).read)
+      File.open(out_path, 'w') do |f|
+        f.write erb.result(b)
+      end
+    end
+
+    def self.mkdir(out_path)
+      dir = out_path[0, out_path.rindex('/')]
+      unless File.exist?(dir)
+        FileUtils.mkdir_p(dir)
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: web-ext-native-app-packer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mika
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-17 00:00:00.000000000 Z
+dependencies: []
+description: "    web extension native application packer!\n"
+email: Mika@nothing.org
+executables:
+- web-ext-native-app-packer
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/web-ext-native-app-packer
+- lib/pack.sh
+- lib/template/app-loader.bat.erb
+- lib/template/install-unix-like.sh.erb
+- lib/template/install-windows.bat.erb
+- lib/template/manifest.json.erb
+- lib/template/uninstall-unix-like.sh.erb
+- lib/template/uninstall-windows.bat.erb
+- lib/web-ext-native-app-packer.rb
+homepage: https://github.com/mika-cn/web-ext-native-app-packer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: web extension native application packer!
+test_files: []