extensionator 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c159fab576ebc4eee9fafc8e9c67cb3c057acf9f
-  data.tar.gz: 67917fd1539033b7bfdc84a55e80f7b58b4e71d6
+  metadata.gz: 3780dd6f297b930567d87ad3db41b44f43702759
+  data.tar.gz: 9ac68018622dff9e312be10be2cfe97522ec35e2
 SHA512:
-  metadata.gz: 430508a2a39100f6fe3b34357d6e323bc85e8fe4d08548a967cfa6b94adc7c74c19147c0d787daf43a29ee60101258ba397a3616812297d5a5cbb8aaf13f0bf8
-  data.tar.gz: 7dc51d6fd2646d24ea6dbc1b8eb1bfcbfb2495cf2ea592898c0e07a0636517fb7c03732fcdc8d692dd459b347af7464d32f7ce1d8b7f609d2cdb0e718dcd02c8
+  metadata.gz: 7806db009edfc01d8e56a9aced37d2e287b2b37293464977d49b1e748cfedef0e5da1665bd7f709cd8dffcf91cea4e6234c12b982eadabd1bcbaac8ff2368bfa
+  data.tar.gz: 61eb7af4225a22e2397baf1427507ece88a658c630c22d00c6cd5d53bb7ff22e28d7cbdfaba5f5e4bcd40c120661dbfe196de15eccfd69ee82500966f8c47a6c

data/README.md

@@ -2,13 +2,12 @@
 
 Package Chrome extensions. Inspired by [crxmake][crxmake-url], but with an eye towards simplicity and supportability. Use the CLI or the Ruby API.
 
-[![Gem Version][gem-img]][gem-url]
-[![License][license-img]][license]
-[![Gem Downloads][gem-dl-img]][gem-url]
+[![Gem Version][gem-image]][gem-url]
+[![MIT License][license-image]][license]
+[![Gem Downloads][gem-dl-image]][gem-url]
 [![Build Status][travis-image]][travis-url]
-[![Code Climate][code-climate-img]][code-climate-url]
+[![Code Climate][code-climate-image]][code-climate-url]
 [![Dependencies][gemnasium-image]][gemnasium-url]
-![Phasers to stun][phasers-image]
 
 ## Install
 
@@ -70,18 +69,20 @@ Extensionator.create("dir", "key.pem", "output_file.crx", exclude: /\.md$/)
 
 Copyright 2015 Zensight. Distributed under the MIT License. See the [LICENSE][] file for more details.
 
-[license-img]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
+![Phasers to stun][phasers-image]
+
+[license-image]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
 [license]: LICENSE.md
 
-[code-climate-img]: https://img.shields.io/codeclimate/github/Zensight/extensionator.svg?style=flat-square
+[code-climate-image]: https://img.shields.io/codeclimate/github/Zensight/extensionator.svg?style=flat-square
 [code-climate-url]: https://codeclimate.com/github/Zensight/extensionator
 
-[gem-img]: https://img.shields.io/gem/v/extensionator.svg?style=flat-square
-[gem-dl-img]: https://img.shields.io/gem/dt/extensionator.svg?style=flat-square
+[gem-image]: https://img.shields.io/gem/v/extensionator.svg?style=flat-square
+[gem-dl-image]: https://img.shields.io/gem/dt/extensionator.svg?style=flat-square
 [gem-url]: https://rubygems.org/gems/extensionator
 
-[travis-url]: http://travis-ci.org/zensight/extensionator
-[travis-image]: http://img.shields.io/travis/zensight/extensionator.svg?style=flat-square
+[travis-url]: http://travis-ci.org/Zensight/extensionator
+[travis-image]: http://img.shields.io/travis/Zensight/extensionator.svg?style=flat-square
 
 [gemnasium-url]: https://gemnasium.com/zensight/extensionator
 [gemnasium-image]: https://img.shields.io/gemnasium/Zensight/extensionator.svg?style=flat-square

data/bin/extensionator

@@ -2,8 +2,10 @@
 
 begin
   require_relative "../lib/extensionator"
+  require_relative "../lib/extensionator/cli"
 rescue LoadError
   require "extensionator"
+  require "../lib/extensionator/cli"
 end
 
 Extensionator::CLI.start

data/lib/extensionator.rb

@@ -1,7 +1,24 @@
-Dir["#{__dir__}/extensionator/*.rb"].each{|f| require f}
+require_relative "extensionator/error"
+require_relative "extensionator/manifest"
+require_relative "extensionator/crx"
+require_relative "extensionator/creator"
 
 module Extensionator
-  def self.create(dir, key_file, dest_filename, opts = {exclude: /\.crx$/})
-    Impl.create(dir, key_file, dest_filename, opts)
+
+  def self.validate(dir, opts={})
+    Creator.new(dir, opts).validate
+  end
+
+  def self.crx(dir, identity_file, dest_filename, opts = {})
+    Creator.new(dir, opts.merge(identity: identity_file)).crx(dest_filename)
+  end
+
+  def self.zip(dir, dest_filename, opts= {})
+    Creator.new(dir, opts).zip(dest_filename)
+  end
+
+  ##deprecated, reverse compat
+  def self.create(dir, identity_file, dest_filename, opts = {})
+    crx(dir, identity_file, dest_filename, opts)
   end
 end

data/lib/extensionator/cli.rb

@@ -1,13 +1,18 @@
 require "slop"
+require_relative "../extensionator"
 
 module Extensionator
   module CLI
     def self.start
       opts = Slop.parse do |o|
-        o.string "-d", "--directory", "Directory containing the extension. (Default: .)", default: "."
-        o.string "-i", "--identity", "Location of the pem file to sign with. (Required)"
-        o.string "-o", "--output", "Location of the output file. (Default: 'extension.crx')", default: "extension.crx"
-        o.string "-e", "--exclude", "Regular expression for filenames to exclude. (Default: \.crx$)", default: nil
+        o.string "-d", "--directory", "Directory containing the extension. (Default: .)"
+        o.string "-i", "--identity", "Location of the pem file to sign with."
+        o.string "-o", "--output", "Location of the output file. (Default: 'extension.[zip|crx]')"
+        o.string "-e", "--exclude", "Regular expression for filenames to exclude. (Default: \.crx$)"
+        o.string "-f", "--format", "Type of file to produce, either zip or crx. Defaults to crx"
+        o.string "--inject-version", "Inject a version number into the manifest file."
+        o.bool "--inject-key", "Inject a key parameter into the manifest file."
+        #o.string "--skip-validation", "Don't try to validate this extension."
         o.on "-v", "--version", "Extensionator version info." do
           puts Extensionator::VERSION
           exit
@@ -18,12 +23,19 @@ module Extensionator
         end
       end
 
-      abort("No identity file specified; use --identity or -i switch.") unless opts[:identity]
+      creator = Creator.new(opts[:directory], opts)
+      if opts[:format] == "zip"
+        creator.zip(opts[:output] || "output.zip")
+      else
+        creator.crx(opts[:output] || "output.crx")
+      end
+
+    end
 
-      Extensionator.create(opts[:directory],
-                           opts[:identity],
-                           opts[:output],
-                           exclude: opts[:exclude] ? Regexp.new(opts[:exclude]) : nil)
+    def self.fixup_options(in_opts)
+      opts = in_opts.clone
+      opts[:output] = output.to_sym if opts[:output]
+      opts[:exclude] = Regexp.new(opts[:exclude]) if opts[:exclude]
     end
   end
 end

data/lib/extensionator/creator.rb

@@ -0,0 +1,110 @@
+require "find"
+require "openssl"
+require "pathname"
+require "zip"
+
+module Extensionator
+  class Creator
+
+    def initialize(dir, options)
+      @dir = dir
+      @opts = {
+        inject_key: false,
+        inject_version: nil,
+        skip_validation: false
+      }.merge(options)
+    end
+
+    def zip(destination)
+      with_files("zip") do |zip_str|
+        File.open(destination, "wb"){|f| f.write zip_str}
+      end
+    end
+
+    def crx(destination)
+      with_files("crx") do |zip_str|
+        CRX.create(destination, zip_str, private_key)
+      end
+    end
+
+    def validate
+      manifest.validate(dir_files)
+    end
+
+    private
+
+    def with_files(default_extension)
+      files = process_directory
+      yield zip_up(files)
+    end
+
+    def process_directory
+      new_paths = dir_files
+
+      manifest.validate(new_paths) unless @opts[:skip_validation]
+      manifest.inject_key(private_key) if @opts[:inject_key]
+      manifest.inject_version(@opts[:inject_version]) if @opts[:inject_version]
+
+      new_paths << manifest.write if manifest_updated?
+
+      new_paths
+    end
+
+    def zip_up(paths)
+      Zip.continue_on_exists_proc = true
+      Zip::File.add_buffer do |zip|
+        paths.each do |path_combo|
+          path_in_zip, file = path_combo
+          if File.directory?(file)
+            zip.mkdir(path_in_zip, file)
+          else
+            zip.add(path_in_zip, file)
+          end
+        end
+      end.string
+    end
+
+    def dir_files
+      unless @dir_files
+        @dir_files = []
+        Find.find(@dir) do |path|
+          case
+            when path == @dir
+              next
+            when (@opts[:exclude] && path =~ @opts[:exclude])
+              Find.prune
+            else
+              @dir_files << [relative_path(@dir, path), path]
+          end
+        end
+      end
+      @dir_files
+    end
+
+    def manifest
+      @manifest ||= Manifest.new(@dir)
+    end
+
+    def manifest_updated?
+      @manifest && @manifest.updated?
+    end
+
+    def private_key
+      @private_key ||=
+        if @opts[:identity]
+          begin
+            OpenSSL::PKey::RSA.new(File.read(@opts[:identity]))
+          rescue Error => e
+            raise KeyError.new("Couldn't read key file #{@opts[:identity]}: #{e.message}")
+          end
+        else
+          raise ArgumentError.new("You need to specify an identity file for this operation.")
+        end
+    end
+
+    def relative_path(base, target)
+      from, to = [base, target].map(&Pathname.method(:new))
+      to.relative_path_from(from).to_s
+    end
+  end
+end

data/lib/extensionator/crx.rb

@@ -0,0 +1,34 @@
+require "digest/sha1"
+
+module Extensionator
+  module CRX
+
+    def self.create(destination, zip_str, priv_key)
+      sig_bytes = sign(zip_str, priv_key)
+      write_crx(destination, zip_str, sig_bytes, priv_key)
+    end
+
+    def self.sign(zip_str, priv_key)
+      priv_key.sign(OpenSSL::Digest::SHA1.new, zip_str)
+    end
+
+    def self.write_crx(destination, zip_str, sig_bytes, priv_key)
+      pub_key_bytes = priv_key.public_key.to_der
+
+      #See https://developer.chrome.com/extensions/crx for the format description
+      File.open(destination, "wb") do |file|
+        file << "Cr24"
+        file << format_size(2)
+        file << format_size(pub_key_bytes.size)
+        file << format_size(sig_bytes.size)
+        file << pub_key_bytes
+        file << sig_bytes
+        file << zip_str
+      end
+    end
+
+    def self.format_size(num)
+      [num].pack("V")
+    end
+  end
+end

data/lib/extensionator/error.rb

@@ -0,0 +1,9 @@
+module Extensionator
+  class Error < StandardError
+
+    ArgumentError = Class.new(self)
+    KeyError = Class.new(self)
+    ValidationError = Class.new(self)
+  end
+end
+

data/lib/extensionator/manifest.rb

@@ -0,0 +1,47 @@
+require "json"
+require "base64"
+
+module Extensionator
+  class Manifest
+
+    def initialize(dir)
+      manifest_file = "#{dir}/manifest.json"
+
+      raise "Can't find manifest file" unless File.exists? manifest_file
+
+      begin
+        @manifest = JSON.parse(File.read(manifest_file))
+      rescue Errno::ENOTENT => e
+        raise ValidationError.new("Can't read manifest file: #{e.message}")
+      rescue JSON::ParserError => e
+        raise ValidationError.new("Can't parse manifest file: #{e.message}")
+      end
+    end
+
+    def validate(paths)
+      #todo: actual validations!
+      true
+    end
+
+    def inject_key(priv_key)
+      #Chrome appears to support some shorter encoding of the pub key, but I'm not sure what it is
+      @manifest["key"] = Base64.encode64(priv_key.public_key.to_der).gsub("\n", "")
+      @updated = true
+    end
+
+    def inject_version(version)
+      @manifest["version"] = version
+      @updated = true
+    end
+
+    def updated?
+      @updated || false
+    end
+
+    def write
+      file = Tempfile.new("crx-manifest.json")
+      File.open(file, "w"){|f| f.write(JSON.dump(@manifest))}
+      ["manifest.json", file.path]
+    end
+  end
+end

data/lib/extensionator/version.rb

@@ -1,3 +1,3 @@
 module Extensionator
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extensionator
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Isaac Cambron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-23 00:00:00.000000000 Z
+date: 2015-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,7 +65,10 @@ files:
 - extensionator.gemspec
 - lib/extensionator.rb
 - lib/extensionator/cli.rb
-- lib/extensionator/impl.rb
+- lib/extensionator/creator.rb
+- lib/extensionator/crx.rb
+- lib/extensionator/error.rb
+- lib/extensionator/manifest.rb
 - lib/extensionator/version.rb
 homepage: http://github.com/zensight/extensionator/
 licenses:

data/lib/extensionator/impl.rb

@@ -1,65 +0,0 @@
-require "digest/sha1"
-require "find"
-require "openssl"
-require "pathname"
-require "zip"
-
-module Extensionator
-  module Impl
-    def self.create(dir, key_file, dest_filename, opts)
-      priv_key = read_key(key_file)
-      zip_str = zip(dir, opts)
-      sig_bytes = sign(zip_str, priv_key)
-      write(zip_str, sig_bytes, priv_key, dest_filename)
-    end
-
-    def self.read_key(key_file)
-      OpenSSL::PKey::RSA.new(File.read(key_file))
-    end
-
-    def self.zip(dir, opts = {})
-      Zip::File.add_buffer do |zip|
-        Find.find(dir) do |path|
-          case
-            when path == dir
-              next
-            when  (opts[:exclude] && path =~ opts[:exclude])
-              Find.prune
-            when File.directory?(path)
-              zip.mkdir(relative_path(dir, path))
-            else
-              zip.add(relative_path(dir, path), path)
-          end
-        end
-      end.string
-    end
-
-    def self.sign(zip_str, priv_key)
-      priv_key.sign(OpenSSL::Digest::SHA1.new, zip_str)
-    end
-
-    def self.write(zip_str, sig_bytes, priv_key, dest_filename)
-      pub_key_bytes = priv_key.public_key.to_der
-
-      #See https://developer.chrome.com/extensions/crx for the format description
-      File.open(dest_filename, "wb") do |file|
-        file << "Cr24"
-        file << format_size(2)
-        file << format_size(pub_key_bytes.size)
-        file << format_size(sig_bytes.size)
-        file << pub_key_bytes
-        file << sig_bytes
-        file << zip_str
-      end
-    end
-
-    def self.relative_path(base, target)
-      from, to = [base, target].map(&Pathname.method(:new))
-      to.relative_path_from(from).to_s
-    end
-
-    def self.format_size(num)
-      [num].pack("V")
-    end
-  end
-end