push_package 0.0.3 → 0.1.0

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+language: ruby
+rvm:
+- 1.9.3
+- jruby-19mode
+- rbx-19mode
+- 2.0.0
+notifications:
+  email:
+  - adam.v.duke@gmail.com
+  - stefan.natchev@gmail.com

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    push_package (0.0.3)
+    push_package (0.1.0)
+      rubyzip (~> 1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -14,6 +15,7 @@ GEM
       method_source (~> 0.8)
       slop (~> 3.4)
     rake (10.0.3)
+    rubyzip (1.1.0)
     slop (3.4.6)
 
 PLATFORMS

data/README.md

@@ -1,14 +1,43 @@
+# Push Package
+
 ## Purpose
-Make implementing safari push notifications easier for ruby developers.
+
+This gem provides a Ruby library and command line tool for creating a push package to be used for [Safari Push Notifications](https://developer.apple.com/library/mac/documentation/NetworkingInternet/Conceptual/NotificationProgrammingGuideForWebsites/PushNotifications/PushNotifications.html#//apple_ref/doc/uid/TP40013225-CH3-SW24).
+
+## Features
+
+* Validates push package contents
+* Generates manifest.json
+* Signs package with required signature
+* Creates pushPackage.zip
+
+## Installation
+
+```gem install push_package```
 
 ## Notes:
 
+This gem depends on `zip` being in your shell's `PATH`
+
+You must obtain a Website Push certificate from apple which requires a iOS developer license or a Mac developer license
+
 ```ruby
-def create
-  package = PushPackage.new(website_params, iconset_path, certificate)
-  package.save('path/to/save')
-  send_file 'path/to/save'
-end
+require 'push_package'
+
+website_params = {
+  websiteName: "Bay Airlines",
+  websitePushID: "web.com.example.domain",
+  allowedDomains: ["http://domain.example.com"],
+  urlFormatString: "http://domain.example.com/%@/?flight=%@",
+  authenticationToken: "19f8d7a6e9fb8a7f6d9330dabe",
+  webServiceURL: "https://example.com/push"
+}
+
+iconset_path = 'path/to/iconset'
+certificate = 'path/to/certificate.p12' # or certificate_string
+package = PushPackage.new(website_params, iconset_path, certificate, 'optional cert password')
+package.save('path/to/save')
+
 ```
 
 ```shell

data/lib/push_package.rb

@@ -2,7 +2,9 @@ require 'push_package/version'
 require 'json'
 require 'fileutils'
 require 'tmpdir'
+require 'tempfile'
 require 'openssl'
+require 'zip'
 
 class PushPackage
   class InvalidIconsetError < StandardError; end
@@ -30,40 +32,66 @@ class PushPackage
     @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
+  def save(output_path = nil)
 
-      Dir.mkdir(File.join(dir,'icon.iconset'))
-      Dir.glob(@iconset_path + '/*.png').each do |icon|
-        FileUtils.cp(icon, dir + '/icon.iconset/')
-      end
+    @working_dir = Dir.mktmpdir('pushPackage')
 
-      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
+    if output_path
+      output_path = File.expand_path(output_path)
+    else
+      output_path = Dir.tmpdir + '/pushPackage.zip'
+    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)
+    ## overwrite existing push packages
+    File.delete(output_path) if File.exists?(output_path)
 
-      File.open(dir + '/signature', 'wb+') do |file|
-        file << signature.to_der
-      end
+    zip = Zip::File.open(output_path, Zip::File::CREATE)
+
+    File.open(@working_dir + '/website.json', 'w+') do |json|
+      json.write(JSON.dump(@website_params))
+    end
+
+    Dir.mkdir(File.join(@working_dir,'icon.iconset'))
+    Dir.glob(@iconset_path + '/*.png').each do |icon|
+      FileUtils.cp(icon, @working_dir + '/icon.iconset/')
+    end
 
-      `pushd #{dir}; zip -r #{output_path} ./; popd`
+    File.open(@working_dir + '/manifest.json', 'w+') do |manifest|
+      manifest.write(manifest_data)
     end
 
+    File.open(@working_dir + '/signature', 'wb+') do |file|
+      file.write(signature.to_der)
+    end
+
+    Dir.glob(@working_dir + '/**/*').each do |file|
+      next if File.directory?(file)
+      zip.add(file.gsub("#{@working_dir}/", ''), file)
+    end
+
+    zip.close
+
+    #clean up the temporary directory
+    FileUtils.remove_entry_secure(@working_dir)
+
+    #re-open the file for reading
     File.open(output_path, 'r')
   end
 
   private
 
+    def signature
+      #use the certificate to create a pkcs7 detached signature
+      OpenSSL::PKCS7::sign(@p12.certificate, @p12.key, manifest_data, [], OpenSSL::PKCS7::BINARY | OpenSSL::PKCS7::DETACHED)
+    end
+
+    def manifest_data
+      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(@working_dir, file)).hexdigest }
+      Hash[manifest_keys.zip(manifest_values)].to_json
+    end
+
     def valid_website_params?(params)
       REQUIRED_WEBSITE_PARAMS.all? do |param|
         params.keys.include?(param)

data/lib/push_package/version.rb

@@ -1,3 +1,3 @@
 class PushPackage
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/push_package.gemspec

@@ -5,7 +5,7 @@ require 'push_package/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "push_package"
-  gem.version       = PushPackage::VERSION
+  gem.version       = PushPackage::VERSION.dup
   gem.authors       = ["Stefan Natchev", "Adam Duke"]
   gem.email         = ["stefan.natchev@gmail.com", "adam.v.duke@gmail.com"]
   gem.summary       = %q{A gem for creating Safari push notification push packages.}
@@ -19,6 +19,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.required_ruby_version = '>= 1.9'
 
+  gem.add_runtime_dependency 'rubyzip', '~> 1.1.0'
+
   gem.add_development_dependency 'minitest',      '~> 4.7.0'
   gem.add_development_dependency 'rake',          '~> 10.0.3'
   gem.add_development_dependency 'pry'

data/spec/push_package_spec.rb

@@ -84,7 +84,19 @@ describe PushPackage do
     end
 
     it 'should save to the file system' do
-      File.exist?(output_path).must_equal(true)
+      File.exist?(output_path).must_equal true
+    end
+
+    it 'should save with a relative path' do
+      push_package.save('pushPackage.zip')
+      File.exist?('./pushPackage.zip').must_equal true
+      File.delete('./pushPackage.zip')
+    end
+
+    it 'should save to a temporary path' do
+      file = push_package.save
+      File.exist?(file.path).must_equal true
+      File.delete(file.path)
     end
 
     it 'should return the file handle' do

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: push_package
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Stefan Natchev
@@ -9,11 +10,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2013-12-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -21,6 +39,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -28,6 +47,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -35,6 +55,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -42,6 +63,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -49,6 +71,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -63,6 +86,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -86,26 +110,27 @@ files:
 homepage: https://github.com/symmetricinfinity/push_package
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.0
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A gem for creating Safari push notification push packages.
 test_files:
 - spec/fixtures/iconset/icon_128x128.png

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjE5YzE1ZWIwZGY2OGQxNDM3YmE1NWIwN2U4ZGFiZTgxMDY3ZTk1Ng==
-  data.tar.gz: !binary |-
-    NDJlZTBmM2ZlNmY5NTAzM2NjY2MxYWZhN2MxN2FiMmI0ODNhMzQ4OQ==
-SHA512:
-  metadata.gz: !binary |-
-    ZGFhYzJmYWM3YWZkZWUwMGUwNWUxNjFiNGI5NWZhZDQ3NTljMmQ4ZDAwZWY4
-    NWRmMDcwYmViZGI5ZTQ5OTkwZjIwNzY5ZjU0MTkzNTBiNmUyOWY1MDUwMGMw
-    NDk4MGQ4YWNjYzQzMjA1MWRjOWMyYjkwMTJlNDNjY2Y0M2E5MzA=
-  data.tar.gz: !binary |-
-    ZDg3ZTUxZDRlZTFlM2VjNTFmZGY5YTgxN2JjZjk3ZWIxYjZlODAxZjNlMDY1
-    OGMzNWRlNTIyNTI3ODcxMzExZWEyZTRjMTI2YjE0NWM1YWIwZGUwNjJiNzRl
-    MTAxYWIxMTljMTQ5NjVlZmU1NWVkZDdiMjYzNWIyZTRiM2VmODg=