crx_unpack 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35671687290d12fd310aad815c35a0d3c9fbf390
+  data.tar.gz: 068af8fe5bc7de7cbb50f611069a297fb5afab0d
+SHA512:
+  metadata.gz: ba35e105088719caf5d0e54a2fe17eeab03540b70af3c6a1b448b5b592766b5872b5cf363b7681efe439623789c0503c2ef908c690a0db875dd5c9506421bffd
+  data.tar.gz: 25381eb5cf3f95cd4e06d290c02c4b6dc37043792991ccf4c0e29e250762ff1a2b970cdfe2317a6a38ddf7cafaa73394eeec67d4c230d4b4ba8e22f42703f116

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.0.1
+
+* Initial release
+* Implement public methods `CrxUnpack#unpack`, `CrxUnpack#unpack_from_io`, `CrxUnpack#unpack_from_file`, `CrxUnpack#unpack_contents`, `CrxUnpack#unpack_contents_from_io`, `CrxUnpack#unpack_contents_from_file`, `CrxUnpack.unpack`, `CrxUnpack.unpack_from_io`, `CrxUnpack.unpack_from_file`, `CrxUnpack.unpack_contents`, `CrxUnpack.unpack_contents_from_io` and `CrxUnpack.unpack_contents_from_file`
+* Add rspec test

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in crx_unpack.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kensuke Nagae
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# CrxUnpack
+
+[![Build Status](https://travis-ci.org/kyanny/crx_unpack.png)](https://travis-ci.org/kyanny/crx_unpack)
+
+Unpack [Chrome extension (crx)](http://developer.chrome.com/extensions/crx.html) file
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'crx_unpack'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crx_unpack
+
+## Usage
+
+```ruby
+require 'crx_unpack'
+
+data = open('extension.crx', 'rb').read
+crx = CrxUnpack.unpack(data)
+crx.zip #=> zip data of extension contents
+
+# unzip extension contents into `./extension' directory
+CrxUnpack.unpack_contents_from_file('extension.crx', './extension')
+```
+
+## 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

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+task :default => :spec

data/bin/crx_unpack

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require 'crx_unpack'
+
+crx = ARGV.shift
+dest = ARGV.shift
+unless crx && dest
+  puts <<USAGE
+Usage: #{File.basename($0)} extension.crx dest
+
+USAGE
+  exit!
+end
+
+CrxUnpack.unpack_contents_from_file(crx, dest)

data/crx_unpack.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crx_unpack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "crx_unpack"
+  spec.version       = CrxUnpack::VERSION
+  spec.authors       = ["Kensuke Nagae"]
+  spec.email         = ["kyanny@gmail.com"]
+  spec.description   = %q{Unpack Chrome extension (crx) file}
+  spec.summary       = %q{Unpack Chrome extension (crx) file}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.executables   = %w(crx_unpack)
+
+  spec.add_dependency "rubyzip"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/crx_unpack.rb

@@ -0,0 +1,85 @@
+require "crx_unpack/version"
+require 'zip/zip'
+require 'fileutils'
+
+class CrxUnpack
+  attr_reader :magic, :version, :public_key_length, :signature_length, :public_key, :signature, :zip
+
+  def unpack(data)
+    @magic = data.slice!(0, 4)
+    @version = data.slice!(0, 4)
+    @public_key_length = data.slice!(0, 4).unpack("i*")[0]
+    @signature_length = data.slice!(0, 4).unpack("i*")[0]
+    @public_key = data.slice!(0, public_key_length)
+    @signature = data.slice!(0, signature_length)
+    @zip = data
+    self
+  end
+
+  def unpack_from_io(io)
+    io.binmode? || io.binmode
+    unpack(io.read)
+  end
+
+  def unpack_from_file(file)
+    unpack(open(file, 'rb').read)
+  end
+
+  def unpack_contents(data, dest, leave_zip_file=false)
+    unpack(data)
+    dest = File.expand_path(dest)
+    unless Dir.exists?(dest)
+      Dir.mkdir(dest)
+    end
+
+    Dir.chdir(dest) do
+      zip_file = 'extension.zip'
+      open(zip_file, 'wb'){ |f| f.write zip }
+
+      $stdout.reopen('/dev/null') # Ignore `Invalid date/time in zip entry' warning
+      zf = Zip::ZipFile.new(zip_file)
+      zf.each do |entry|
+        zf.extract(entry, entry.to_s)
+      end
+      $stdout.flush
+      $stdout.reopen(STDERR)
+
+      File.unlink(zip_file) unless leave_zip_file
+    end
+  end
+
+  def unpack_contents_from_io(io, dest, leave_zip_file=false)
+    io.binmode? || io.binmode
+    unpack_contents(io.read, dest, leave_zip_file)
+  end
+
+  def unpack_contents_from_file(file, dest, leave_zip_file=false)
+    unpack_contents(open(file, 'rb').read, dest, leave_zip_file)
+  end
+
+  class << self
+    def unpack(data)
+      new.unpack(data)
+    end
+
+    def unpack_from_io(io)
+      new.unpack_from_io(io)
+    end
+
+    def unpack_from_file(file)
+      new.unpack_from_file(file)
+    end
+
+    def unpack_contents(data, dest, leave_zip_file=false)
+      new.unpack_contents(data, dest, leave_zip_file)
+    end
+
+    def unpack_contents_from_io(io, dest, leave_zip_file=false)
+      new.unpack_contents_from_io(io, dest, leave_zip_file)
+    end
+
+    def unpack_contents_from_file(file, dest, leave_zip_file=false)
+      new.unpack_contents_from_file(file, dest, leave_zip_file)
+    end
+  end
+end

data/lib/crx_unpack/version.rb

@@ -0,0 +1,3 @@
+class CrxUnpack
+  VERSION = "0.0.1"
+end

data/spec/crx_unpack_spec.rb

@@ -0,0 +1,164 @@
+require 'crx_unpack'
+require 'tmpdir'
+require 'digest/sha1'
+
+shared_context 'Move to temporary directory' do
+  before do
+    @pwd = Dir.pwd
+    @tmpdir = Dir.mktmpdir
+    Dir.chdir(@tmpdir)
+  end
+
+  after do
+    Dir.chdir(@pwd)
+    FileUtils.rm_r(@tmpdir)
+  end
+end
+
+def sha1hex(file)
+  Digest::SHA1.hexdigest open(file).read
+end
+
+describe CrxUnpack do
+  let(:crx_file) do
+    File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', 'extension.crx'))
+  end
+
+  let(:crx_io) do
+    open(crx_file, 'rb')
+  end
+
+  let(:crx_data) do
+    open(crx_file, 'rb').read
+  end
+
+  let(:fixture_files) do
+    Dir.glob(File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', 'extension', '*')))
+  end
+
+  describe '#unpack' do
+    it 'unpacks crx data' do
+      subject.unpack(crx_data)
+      expect(subject.zip[0,2]).to eq("PK")
+    end
+  end
+
+  describe '#unpack_from_io' do
+    it 'unpacks crx data from io' do
+      subject.unpack_from_io(crx_io)
+      expect(subject.zip[0,2]).to eq("PK")
+    end
+  end
+
+  describe '#unpack_from_file' do
+    it 'unpacks crx data from file' do
+      subject.unpack_from_file(crx_file)
+      expect(subject.zip[0,2]).to eq("PK")
+    end
+  end
+
+  describe '.unpack' do
+    it 'unpacks crx data' do
+      crx = described_class.unpack(crx_data)
+      expect(crx.zip[0,2]).to eq("PK")
+    end
+  end
+
+  describe '.unpack_from_io' do
+    it 'unpacks crx data from io' do
+      crx = described_class.unpack_from_io(crx_io)
+      expect(crx.zip[0,2]).to eq("PK")
+    end
+  end
+
+  describe '.unpack_from_file' do
+    it 'unpacks crx data from file' do
+      crx = described_class.unpack_from_file(crx_file)
+      expect(crx.zip[0,2]).to eq("PK")
+    end
+  end
+
+  describe '#unpack_contents' do
+    include_context 'Move to temporary directory'
+
+    it 'unpacks crx contents' do
+      subject.unpack_contents(crx_data, 'extension')
+
+      Dir.chdir('extension') do
+        fixture_files.each do |file|
+          expect(sha1hex(File.basename(file))).to eq(sha1hex(file))
+        end
+      end
+    end
+  end
+
+  describe '#unpack_contents_from_io' do
+    include_context 'Move to temporary directory'
+
+    it 'unpacks crx contents from io' do
+      subject.unpack_contents_from_io(crx_io, 'extension')
+
+      Dir.chdir('extension') do
+        fixture_files.each do |file|
+          expect(sha1hex(File.basename(file))).to eq(sha1hex(file))
+        end
+      end
+    end
+  end
+
+  describe '#unpack_contents_from_file' do
+    include_context 'Move to temporary directory'
+
+    it 'unpacks crx contents from file' do
+      subject.unpack_contents_from_file(crx_file, 'extension')
+
+      Dir.chdir('extension') do
+        fixture_files.each do |file|
+          expect(sha1hex(File.basename(file))).to eq(sha1hex(file))
+        end
+      end
+    end
+  end
+
+  describe '.unpack_contents' do
+    include_context 'Move to temporary directory'
+
+    it 'unpacks crx contents' do
+      described_class.unpack_contents(crx_data, 'extension')
+
+      Dir.chdir('extension') do
+        fixture_files.each do |file|
+          expect(sha1hex(File.basename(file))).to eq(sha1hex(file))
+        end
+      end
+    end
+  end
+
+  describe '.unpack_contents_from_io' do
+    include_context 'Move to temporary directory'
+
+    it 'unpacks crx contents from io' do
+      described_class.unpack_contents_from_io(crx_io, 'extension')
+
+      Dir.chdir('extension') do
+        fixture_files.each do |file|
+          expect(sha1hex(File.basename(file))).to eq(sha1hex(file))
+        end
+      end
+    end
+  end
+
+  describe '.unpack_contents_from_file' do
+    include_context 'Move to temporary directory'
+
+    it 'unpacks crx contents from file' do
+      described_class.unpack_contents_from_file(crx_file, 'extension')
+
+      Dir.chdir('extension') do
+        fixture_files.each do |file|
+          expect(sha1hex(File.basename(file))).to eq(sha1hex(file))
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/extension/manifest.json

@@ -0,0 +1,15 @@
+{
+  "manifest_version": 2,
+
+  "name": "One-click Kittens",
+  "description": "This extension demonstrates a 'browser action' with kittens.",
+  "version": "1.0",
+
+  "browser_action": {
+    "default_icon": "icon.png",
+    "default_popup": "popup.html"
+  },
+  "permissions": [
+    "https://secure.flickr.com/"
+  ]
+}

data/spec/fixtures/extension/popup.html

@@ -0,0 +1,31 @@
+<!doctype html>
+<html>
+  <head>
+    <title>Getting Started Extension's Popup</title>
+    <style>
+      body {
+        min-width: 357px;
+        overflow-x: hidden;
+      }
+
+      img {
+        margin: 5px;
+        border: 2px solid black;
+        vertical-align: middle;
+        width: 75px;
+        height: 75px;
+      }
+    </style>
+
+    <!--
+      - JavaScript and HTML must be in separate files: see our Content Security
+      - Policy documentation[1] for details and explanation.
+      -
+      - [1]: http://developer.chrome.com/extensions/contentSecurityPolicy.html
+     -->
+    <script src="popup.js"></script>
+  </head>
+  <body>
+  </body>
+</html>
+

data/spec/fixtures/extension/popup.js

@@ -0,0 +1,83 @@
+// Copyright (c) 2012 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+/**
+ * Global variable containing the query we'd like to pass to Flickr. In this
+ * case, kittens!
+ *
+ * @type {string}
+ */
+var QUERY = 'kittens';
+
+var kittenGenerator = {
+  /**
+   * Flickr URL that will give us lots and lots of whatever we're looking for.
+   *
+   * See http://www.flickr.com/services/api/flickr.photos.search.html for
+   * details about the construction of this URL.
+   *
+   * @type {string}
+   * @private
+   */
+  searchOnFlickr_: 'https://secure.flickr.com/services/rest/?' +
+      'method=flickr.photos.search&' +
+      'api_key=90485e931f687a9b9c2a66bf58a3861a&' +
+      'text=' + encodeURIComponent(QUERY) + '&' +
+      'safe_search=1&' +
+      'content_type=1&' +
+      'sort=interestingness-desc&' +
+      'per_page=20',
+
+  /**
+   * Sends an XHR GET request to grab photos of lots and lots of kittens. The
+   * XHR's 'onload' event is hooks up to the 'showPhotos_' method.
+   *
+   * @public
+   */
+  requestKittens: function() {
+    var req = new XMLHttpRequest();
+    req.open("GET", this.searchOnFlickr_, true);
+    req.onload = this.showPhotos_.bind(this);
+    req.send(null);
+  },
+
+  /**
+   * Handle the 'onload' event of our kitten XHR request, generated in
+   * 'requestKittens', by generating 'img' elements, and stuffing them into
+   * the document for display.
+   *
+   * @param {ProgressEvent} e The XHR ProgressEvent.
+   * @private
+   */
+  showPhotos_: function (e) {
+    var kittens = e.target.responseXML.querySelectorAll('photo');
+    for (var i = 0; i < kittens.length; i++) {
+      var img = document.createElement('img');
+      img.src = this.constructKittenURL_(kittens[i]);
+      img.setAttribute('alt', kittens[i].getAttribute('title'));
+      document.body.appendChild(img);
+    }
+  },
+
+  /**
+   * Given a photo, construct a URL using the method outlined at
+   * http://www.flickr.com/services/api/misc.urlKittenl
+   *
+   * @param {DOMElement} A kitten.
+   * @return {string} The kitten's URL.
+   * @private
+   */
+  constructKittenURL_: function (photo) {
+    return "http://farm" + photo.getAttribute("farm") +
+        ".static.flickr.com/" + photo.getAttribute("server") +
+        "/" + photo.getAttribute("id") +
+        "_" + photo.getAttribute("secret") +
+        "_s.jpg";
+  }
+};
+
+// Run our kitten generation script as soon as the document's DOM is ready.
+document.addEventListener('DOMContentLoaded', function () {
+  kittenGenerator.requestKittens();
+});

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: crx_unpack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kensuke Nagae
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Unpack Chrome extension (crx) file
+email:
+- kyanny@gmail.com
+executables:
+- crx_unpack
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/crx_unpack
+- crx_unpack.gemspec
+- lib/crx_unpack.rb
+- lib/crx_unpack/version.rb
+- spec/crx_unpack_spec.rb
+- spec/fixtures/extension.crx
+- spec/fixtures/extension/icon.png
+- spec/fixtures/extension/manifest.json
+- spec/fixtures/extension/popup.html
+- spec/fixtures/extension/popup.js
+- spec/spec_helper.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Unpack Chrome extension (crx) file
+test_files:
+- spec/crx_unpack_spec.rb
+- spec/fixtures/extension.crx
+- spec/fixtures/extension/icon.png
+- spec/fixtures/extension/manifest.json
+- spec/fixtures/extension/popup.html
+- spec/fixtures/extension/popup.js
+- spec/spec_helper.rb
+has_rdoc: