push_package 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTdmMDFlZmVlNWE5MDFkYzgzNGVhMjM4ZDAxMTc4YTY4N2VlMDVlNA==
+    YzMyYmUwZDI3OTNhMjQ5ZmMzYTljZDk0M2Y1YmU0NTUwM2M3MTA2OA==
   data.tar.gz: !binary |-
-    OTEwZTQ0NjBkOGZlNTBmYmY5M2QyZmQ3ZTU2NTE0NGFhN2FiYzU2OQ==
+    YmQwOGVjMjRiMTUwZTYzMGM0MGEzM2I1MzcxODczMGRkNGQ0ZGU4Zg==
 SHA512:
   metadata.gz: !binary |-
-    ZjcwNTc2YzVlZDc0MTY3NGMwZTFkNDU5OTE3NGYzN2UyMzljMzc0YTE5OTVm
-    NTk5OGFhZDA1OWZhYjQ1MmJiMmI3NGU0Nzc4MjNlMjM5MTM0MWMwYTRjNGQz
-    NzQzYzcxNjE5MmFiZDRiYzZjODg1MGU1Y2RmYWU1ZDA4MzQ4NTE=
+    MWQzY2NkYzBhZjhjMGI3MzJkMjg4YTZkYzUwYTNiMmE4NzQ5MmJiZDE4NDJi
+    MTdkZGQyY2I0ZDUzZjdmMzc0MjJmYzI4MTk4YjBkMjY0NjU4M2RkZmUyNzJi
+    NzJhNTJkOGVkN2JkODkzYWMyNDQxMDgyYmEwMGE0ZjUyZmZjMTg=
   data.tar.gz: !binary |-
-    MjQ0NTM4NzBkNjg1Y2U4NmY3MWY2MDU2MjcwNTM3ZmE2NWY1ZmNhNzM3YjYw
-    Njk4NjUwZTQ1ZWRhOTllMGRhZDU2ZDE2MzkyMTM4Mzc0YzMyOGRjOTIyYzY0
-    ZWJlZGEyMzk2ZDlhNjAzMmQzNGNhNGEwMjFlZGYwNmY3YjA1Mjk=
+    ZmZjYjNkYWFmOWQxMmY0ZmJmMDIyNDExZDU0MmExMDliZjEzMjM4MWQzOGZl
+    Y2Y1N2I1MDRiNDIzNjIwYmYwMDFmMDdlOWU3MDJhYTdiMmFmMjMxZTUyMDFk
+    NWRkMDk2ZGE0NTVjZjYyZGI4NWNmYjAxMjdkZWVmNzk1YTRjMTY=

data/Gemfile.lock

@@ -1,18 +1,26 @@
 PATH
   remote: .
   specs:
-    push_package (0.0.1)
+    push_package (0.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.0.9)
+    method_source (0.8.2)
     minitest (4.7.0)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     rake (10.0.3)
+    slop (3.4.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   minitest (~> 4.7.0)
+  pry
   push_package!
   rake (~> 10.0.3)

data/README.md

@@ -2,7 +2,19 @@
 Make implementing safari push notifications easier for ruby developers.
 
 ## Notes:
-This is not ready for use.
+
+```ruby
+def create
+  package = PushPackage.new(website_params, iconset_path, certificate)
+  package.save('path/to/save')
+  send_file 'path/to/save'
+end
+```
+
+```shell
+$> push_package --website-json=./website.json --iconset-path=~/project/iconset --output-dir=./ --certificate=./Certificate.p12
+   wrote: ./pushPackage.zip
+```
 
 ## Contributing
 

data/lib/push_package.rb

@@ -1,4 +1,78 @@
 require 'push_package/version'
+require 'json'
+require 'fileutils'
+require 'tmpdir'
+require 'openssl'
 
-module PushPackage
+class PushPackage
+  class InvalidIconsetError < StandardError; end
+  class InvalidParameterError < StandardError; end
+
+  REQUIRED_WEBSITE_PARAMS = ["websiteName", "websitePushID", "allowedDomains", "urlFormatString", "authenticationToken", "webServiceURL"]
+  REQUIRED_ICONSET_FILES  = ["icon_16x16.png", "icon_16x16@2x.png", "icon_32x32.png", "icon_32x32@2x.png", "icon_128x128.png", "icon_128x128@2x.png" ]
+
+  attr_reader :p12
+
+  def initialize(website_params, iconset_path, certificate, password = nil)
+    raise InvalidParameterError unless valid_website_params?(website_params)
+    raise InvalidIconsetError unless valid_iconset?(iconset_path)
+    raise ArgumentError unless certificate
+
+    @website_params = website_params
+    @iconset_path = iconset_path
+
+    if certificate.respond_to?(:read)
+      cert_data = certificate.read
+      certificate.rewind if certificate.respond_to?(:rewind)
+    else
+      cert_data = File.read(certificate)
+    end
+    @p12 = OpenSSL::PKCS12.new(cert_data, password)
+  end
+
+  def save(output_path)
+    Dir.mktmpdir('pushPackage') do |dir|
+      json = File.open(dir + '/website.json', 'w+')
+      json.write(JSON.dump(@website_params))
+      json.close
+
+      Dir.mkdir(File.join(dir,'icon.iconset'))
+      Dir.glob(@iconset_path + '/*.png').each do |icon|
+        FileUtils.cp(icon, dir + '/icon.iconset/')
+      end
+
+      manifest_keys = REQUIRED_ICONSET_FILES.map{|f| 'icon.iconset/' + f }
+      manifest_keys << 'website.json'
+      manifest_values = manifest_keys.map {|file| Digest::SHA1.file(File.join(dir, file)).hexdigest }
+      manifest_data = Hash[manifest_keys.zip(manifest_values)].to_json
+      File.open(dir + '/manifest.json', 'w+') do |manifest|
+        manifest.write(manifest_data)
+      end
+
+      #use the certificate to create a pkcs7 detached signature
+      signature = OpenSSL::PKCS7::sign(@p12.certificate, @p12.key, manifest_data, [], OpenSSL::PKCS7::BINARY | OpenSSL::PKCS7::DETACHED)
+
+      File.open(dir + '/signature', 'wb+') do |file|
+        file << signature.to_der
+      end
+
+      `pushd #{dir}; zip -r #{output_path} ./; popd`
+    end
+
+    File.open(output_path, 'r')
+  end
+
+  private
+
+    def valid_website_params?(params)
+      REQUIRED_WEBSITE_PARAMS.all? do |param|
+        params.keys.include?(param)
+      end
+    end
+
+    def valid_iconset?(iconset_path)
+      REQUIRED_ICONSET_FILES.all? do |file|
+        File.exist?(File.join(iconset_path, file))
+      end
+    end
 end

data/lib/push_package/version.rb

@@ -1,3 +1,3 @@
-module PushPackage
-  VERSION = '0.0.1'.freeze
+class PushPackage
+  VERSION = '0.0.2'.freeze
 end

data/push_package.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'minitest',      '~> 4.7.0'
   gem.add_development_dependency 'rake',          '~> 10.0.3'
+  gem.add_development_dependency 'pry'
 end

data/spec/fixtures/manifest.json

@@ -0,0 +1 @@
+{"icon.iconset/icon_128x128.png":"28969578f1788252807a7d8205db269cb7699fa8","icon.iconset/icon_128x128@2x.png":"dd2bf0e3cb998467b0e5f5ae11675a454ad77601","icon.iconset/icon_16x16.png":"48e791d0c88b92fae51ffa8363821857210fca01","icon.iconset/icon_16x16@2x.png":"5a74d295cc09ca5896a4ceb7cac0d030cc85e894","icon.iconset/icon_32x32.png":"8c71bc22f4cfe12ad98aabe94da6a70fe9f15741","icon.iconset/icon_32x32@2x.png":"750e080d38efe1c227b2498f73f006007f3da24b","website.json":"3eaed6475443b895a49e3a1220e547f2be90434a"}

data/spec/push_package_spec.rb

@@ -1,10 +1,131 @@
 require 'spec_helper'
+require 'fileutils'
 
 describe PushPackage do
 
+  let(:iconset_path) { fixture_path 'iconset' }
+
+  let(:website_params) do
+    {
+      'websiteName' =>  'Push Package Test',
+      'websitePushID' =>  'web.com.symmetricinfinity.push_package',
+      'allowedDomains' =>  ['http://symmetricinfinity.com/push_package/', 'http://lvh.me'],
+      'urlFormatString' =>  'http://symmetricinfinity.com/push_package/?%@=%@',
+      'authenticationToken' =>  'nr2o1spn515949r5q54so22o8rq95575',
+      'webServiceURL' =>  'https://api.zeropush.com/safari'
+    }
+  end
+
+  let(:expected_manifest) do
+    {
+      'icon.iconset/icon_128x128.png' => '28969578f1788252807a7d8205db269cb7699fa8',
+      'icon.iconset/icon_128x128@2x.png' => 'dd2bf0e3cb998467b0e5f5ae11675a454ad77601',
+      'icon.iconset/icon_16x16.png' => '48e791d0c88b92fae51ffa8363821857210fca01',
+      'icon.iconset/icon_16x16@2x.png' => '5a74d295cc09ca5896a4ceb7cac0d030cc85e894',
+      'icon.iconset/icon_32x32.png' => '8c71bc22f4cfe12ad98aabe94da6a70fe9f15741',
+      'icon.iconset/icon_32x32@2x.png' => '750e080d38efe1c227b2498f73f006007f3da24b',
+      'website.json' => '3eaed6475443b895a49e3a1220e547f2be90434a'
+    }
+  end
+
+  let(:certificate) { File.open(fixture_path('self-signed.p12')) }
+
   describe 'the truth' do
     it 'should pass' do
       'test'.must_equal('test')
     end
   end
+
+  describe '.new' do
+    it 'should check website_params' do
+      lambda do
+        PushPackage.new({}, iconset_path, certificate)
+      end.must_raise(PushPackage::InvalidParameterError)
+    end
+
+    it 'must have a valid iconset' do
+      lambda do
+        PushPackage.new(website_params, '/tmp', certificate)
+      end.must_raise(PushPackage::InvalidIconsetError)
+    end
+
+    it 'should support a certificate path' do
+      lambda do
+        PushPackage.new(website_params, iconset_path, nil)
+      end.must_raise(ArgumentError)
+    end
+
+    it 'should support certificate path' do
+      lambda do
+        PushPackage.new(website_params, iconset_path, '/some/file.p12')
+      end.must_raise(Errno::ENOENT)
+    end
+  end
+
+  describe '#save' do
+    let(:output_path) { '/tmp/pushPackage.zip' }
+    let(:tmp_path) { '/tmp/pushPackage' }
+    let(:extracted_package) do
+      `unzip #{output_path} -d #{tmp_path}`
+      Dir.glob(tmp_path + '/**/*').map do |d|
+        d.gsub(tmp_path + '/', '')
+      end
+    end
+
+    let(:push_package) { PushPackage.new(website_params, iconset_path, certificate) }
+
+    before do
+      push_package.save(output_path)
+    end
+
+    after do
+      File.delete(output_path) if File.exist?(output_path)
+      FileUtils.rm_rf(tmp_path)
+    end
+
+    it 'should save to the file system' do
+      File.exist?(output_path).must_equal(true)
+    end
+
+    it 'should return the file handle' do
+      file = push_package.save(output_path)
+      file.must_be_instance_of File
+      File.exists?(file.path).must_equal true
+    end
+
+    it 'should be a zip file' do
+      extracted_package.wont_be_empty
+      $?.success?.must_equal true
+    end
+
+    it 'should have a valid manifest.json file' do
+      extracted_package.must_include('manifest.json')
+      manifest = JSON.load(File.open(tmp_path + '/manifest.json', 'r'))
+      manifest.sort.must_equal(expected_manifest.sort)
+    end
+
+    it 'should have the iconset in icon.iconset subdirectory' do
+      icons = extracted_package.select {|file| file.start_with?('icon.iconset/') }
+      icons = icons.map {|i| i.gsub('icon.iconset/', '') }
+      icons.sort.must_equal(PushPackage::REQUIRED_ICONSET_FILES.sort)
+    end
+
+    it 'should have a website.json file' do
+      extracted_package.must_include('website.json')
+    end
+
+    it 'should have a valid signature' do
+      extracted_package.must_include('signature')
+      signature = File.read(tmp_path + '/signature')
+      p7 = OpenSSL::PKCS7.new(signature)
+      store = OpenSSL::X509::Store.new
+      store.add_cert(push_package.p12.certificate)
+      p7.verify(
+        [push_package.p12.certificate],
+         store,
+         File.read(tmp_path + '/manifest.json'),
+         OpenSSL::PKCS7::DETACHED
+      ).must_equal true
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -2,3 +2,6 @@ require 'minitest/spec'
 require 'minitest/autorun'
 require 'push_package'
 
+def fixture_path(*paths)
+  File.join(File.dirname(__FILE__), 'fixtures', *paths)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: push_package
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Stefan Natchev
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-29 00:00:00.000000000 Z
+date: 2013-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -39,6 +39,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 10.0.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: As of OSX 10.9 Safari can receive push notifications when it is closed.
 email:
 - stefan.natchev@gmail.com
@@ -56,6 +70,15 @@ files:
 - lib/push_package.rb
 - lib/push_package/version.rb
 - push_package.gemspec
+- spec/fixtures/iconset/icon_128x128.png
+- spec/fixtures/iconset/icon_128x128@2x.png
+- spec/fixtures/iconset/icon_16x16.png
+- spec/fixtures/iconset/icon_16x16@2x.png
+- spec/fixtures/iconset/icon_32x32.png
+- spec/fixtures/iconset/icon_32x32@2x.png
+- spec/fixtures/manifest.json
+- spec/fixtures/self-signed.p12
+- spec/fixtures/signature
 - spec/push_package_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/symmetricinfinity/push_package
@@ -83,5 +106,14 @@ signing_key:
 specification_version: 4
 summary: A gem for creating Safari push notification push packages.
 test_files:
+- spec/fixtures/iconset/icon_128x128.png
+- spec/fixtures/iconset/icon_128x128@2x.png
+- spec/fixtures/iconset/icon_16x16.png
+- spec/fixtures/iconset/icon_16x16@2x.png
+- spec/fixtures/iconset/icon_32x32.png
+- spec/fixtures/iconset/icon_32x32@2x.png
+- spec/fixtures/manifest.json
+- spec/fixtures/self-signed.p12
+- spec/fixtures/signature
 - spec/push_package_spec.rb
 - spec/spec_helper.rb