grocer-pushpackager 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd2d3abb604660531db0cd55d1d7344028266a36
+  data.tar.gz: fe2f900f5262f35434e1822661cea84d4ba5ae0f
+SHA512:
+  metadata.gz: 001ebdf1bf63f8bbefb4153fac23b0cda17bef0d0aeaf6513e646a91cc9f1fb2b39b10a55fe9e0d4e3046d1da348b7d413ddb435bac6d5f8a3311ce8d9330ce9
+  data.tar.gz: a9b7748647b89a8699c277c475a270fe142765f6eeb1fd01376922ce2e8f71a891ee87e44abaae7fd0afc22e453fb936001b5e901feac20fcccce36fe801baa9

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

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/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+pushpackager

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p195

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+    - 1.9.3
+    - 2.0.0
+script: rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kurt Nelson
+
+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,33 @@
+# Grocer::Pushpackager
+[![Build Status](https://secure.travis-ci.org/grocer/grocer-pushpackager.png)](http://travis-ci.org/grocer/grocer-pushpackager)
+[![Gem Version](https://badge.fury.io/rb/grocer-pushpackager.png)](http://badge.fury.io/rb/grocer-pushpackager)
+[![Code Climate](https://codeclimate.com/github/grocer/grocer-pushpackager.png)](https://codeclimate.com/github/grocer/grocer-pushpackager)
+[![Coverage Status](https://coveralls.io/repos/grocer/grocer-pushpackager/badge.png?branch=master)](https://coveralls.io/r/grocer/grocer-pushpackager)
+[Documentation](http://rubydoc.info/gems/grocer-pushpackager/)
+
+Builds a PushPackage for Apple's APN for use with Safari/Mavericks
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grocer-pushpackager'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grocer-pushpackager
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 @@
+require "bundler/gem_tasks"

data/grocer-pushpackager.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grocer/pushpackager/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grocer-pushpackager"
+  spec.version       = Grocer::Pushpackager::VERSION
+  spec.authors       = ["Kurt Nelson"]
+  spec.email         = ["kurtisnelson@gmail.com"]
+  spec.description   = %q{Builds push packages for OS X Mavericks web notifications}
+  spec.summary       = <<-DESC
+                          To use push notifications to Safari/OS X with the APN service,
+                          you must build a signed push package that is generated by your web server
+                          for every user. This gem handles building that package.
+                        DESC
+  spec.homepage      = "https://github.com/grocer/grocer-pushpackager"
+  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.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rake'
+  spec.add_dependency 'rubyzip'
+end

data/lib/grocer/pushpackager.rb

@@ -0,0 +1,2 @@
+require "grocer/pushpackager/version"
+require "grocer/pushpackager/package"

data/lib/grocer/pushpackager/icon.rb

@@ -0,0 +1,23 @@
+module Grocer
+  module Pushpackager
+    class Icon
+      attr_reader :name, :contents
+      def initialize(size)
+        @name = "icon_#{size}.png"
+        self
+      end
+
+      def from_file file
+        @contents = file.read
+        file.close
+        self
+      end
+
+      def valid?
+        raise ArgumentError, "invalid icon name" unless @name
+        raise ArgumentError, "missing contents" unless @contents
+        true
+      end
+    end
+  end
+end

data/lib/grocer/pushpackager/icon_set.rb

@@ -0,0 +1,24 @@
+require 'forwardable'
+require_relative 'icon'
+
+module Grocer
+  module Pushpackager
+    class IconSet
+      include Enumerable
+      extend Forwardable
+      def_delegators :@icons, :each, :<<
+      
+      def initialize(config = {})
+        raise ArgumentError, "Missing icon set" unless config[:iconSet]
+        @icons = []
+        config[:iconSet].each do |size, file|
+          @icons << Icon.new(size).from_file(file)
+        end
+      end
+
+      def valid?
+        fail unless @icons.select{|i| i.valid?}.count == @icons.count 
+      end
+    end
+  end
+end

data/lib/grocer/pushpackager/package.rb

@@ -0,0 +1,84 @@
+require 'zip/zip'
+require 'digest/sha1'
+require 'openssl'
+require_relative 'icon_set'
+require_relative 'website'
+
+module Grocer
+  module Pushpackager
+    class Package
+      attr_accessor :key, :certificate, :icon_set, :website
+
+      def initialize(config = {})
+        @icon_set = IconSet.new(config)
+        @website = Website.new(config)
+        @certificate = config[:certificate]
+        @key = config[:key]
+      end
+
+      def authentication_token= value
+        @website.authentication_token = value
+        @signature = nil
+        @website_json = nil
+        @manifest_json = nil
+      end
+
+      def valid?
+        @icon_set.valid?
+        @website.valid?
+        raise ArgumentError, "Missing private key" unless @key
+        raise ArgumentError, "Missing certificate" unless @certificate
+        true
+      end
+
+      def file
+        raise unless self.valid?
+        package = Tempfile.new('package')
+        package.write(build_zip.string)
+        package.close
+        package
+      end
+
+      private
+      def website_json
+        @website_json ||= @website.to_json
+      end
+
+      def manifest_json
+        return @manifest_json if @manifest_json
+        @manifest_json = {
+          :"website.json" => Digest::SHA1.hexdigest(website_json)
+        }.merge(icon_set_manifest).to_json
+      end
+
+      def icon_set_manifest
+        manifest = { }
+        @icon_set.each do |icon|
+          manifest[:"icon.iconset\/#{icon.name}"] = Digest::SHA1.hexdigest(icon.contents)
+        end
+        manifest
+      end
+
+      def signature
+        return @signature if @signature
+        @signature = OpenSSL::PKCS7::sign(@certificate, @key, manifest_json, [], OpenSSL::PKCS7::DETACHED)
+      end
+
+      def build_zip
+        buffer = Zip::ZipOutputStream.write_buffer do |out|
+          @icon_set.each do |icon|
+            out.put_next_entry("icon.iconset/#{icon.name}")
+            out.write icon.contents
+          end
+          out.put_next_entry('website.json')
+          out.write website_json
+          out.put_next_entry('manifest.json')
+          out.write manifest_json
+          out.put_next_entry('signature')
+          out.write signature.to_der
+        end
+        buffer
+      end
+    end
+  end
+end

data/lib/grocer/pushpackager/version.rb

@@ -0,0 +1,5 @@
+module Grocer
+  module Pushpackager
+    VERSION = "0.0.1"
+  end
+end

data/lib/grocer/pushpackager/website.rb

@@ -0,0 +1,44 @@
+require 'uri'
+require 'json'
+
+module Grocer
+  module Pushpackager
+    class Website
+      attr_accessor :authentication_token
+      attr_reader :website_name, :push_id, :allowed_domains, :url_format_string, :web_service_url
+      
+      def initialize(config = {})
+        @website_name = config[:websiteName]
+        @push_id = config[:websitePushID]
+        @allowed_domains = []
+        if config[:allowedDomains]
+          @allowed_domains = config[:allowedDomains].map{|domain| URI(domain)}
+        end
+        @url_format_string = config[:urlFormatString]
+        @web_service_url = URI(config[:webServiceURL])
+        @authentication_token = config[:authenticationToken]
+      end
+
+      def valid?
+        raise ArgumentError if not @website_name or @website_name.empty?
+        raise ArgumentError if not @push_id or @push_id.empty? 
+        raise ArgumentError if not @url_format_string or @url_format_string.empty?
+        raise ArgumentError if not @web_service_url or @web_service_url.to_s.empty? or not ['http', 'https'].include?(@web_service_url.scheme)
+        raise ArgumentError if not @authentication_token or @authentication_token.empty?
+        raise ArgumentError, "Allowed domains" unless @allowed_domains.count > 0
+        true
+      end
+
+      def to_json
+        raise "Invalid website" unless valid?
+        { websiteName: @website_name.to_s,
+          websitePushID: @push_id.to_s,
+          allowedDomains: @allowed_domains.map{|domain| domain.to_s},
+          urlFormatString: @url_format_string.to_s,
+          authenticationToken: @authentication_token.to_s,
+          webServiceURL: @web_service_url.to_s,
+        }.to_json
+      end
+    end
+  end
+end

data/spec/package_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Grocer::Pushpackager::Package do
+  subject {Grocer::Pushpackager::Package}
+  it "can be initialized as a valid object" do
+    package = subject.new({
+      websiteName: "Bay Airlines",
+      websitePushID: "web.com.example.domain",
+      allowedDomains: ["http://domain.example.com"],
+      urlFormatString: "http://domain.example.com/%@/?flight=%@",
+      webServiceURL: "https://example.com/push",
+      iconSet: { },
+      certificate: '',
+      key: ''
+    })
+    expect{package.valid?}.to raise_error ArgumentError
+    package.authentication_token = "19f8d7a6e9fb8a7f6d9330dabe"
+    package.should be_valid
+  end
+
+  context "complete, valid package" do
+    before :all do
+      @pair = test_ssl_pair
+    end
+
+    subject do
+      Grocer::Pushpackager::Package.new({
+      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",
+      certificate: @pair[:certificate],
+      key: @pair[:key],
+      iconSet: {
+        :'16x16' => test_icon,
+        :'16x16@2x' => test_icon,
+        :'32x32' => test_icon,
+        :'32x32@2x' => test_icon,
+        :'128x128' => test_icon,
+        :'128x128@2x' => test_icon
+      }
+      })
+    end
+
+    it{should be_valid}
+
+    it "generates a non-zero file" do
+      subject.send(:build_zip).string.should have_at_least(8).length
+    end
+
+    it "writes out file" do
+      package = subject.file
+      file = File.new('tmp/package.zip', 'w')
+      file.write(package.open.read)
+      package.unlink
+      file.should have_at_least(1).length
+      file.close
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'coveralls'
+Coveralls.wear!
+require 'pry'
+require 'rspec'
+
+require 'grocer/pushpackager'
+
+# Requires supporting files with custom matchers and macros, etc,
+# # in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+RSpec.configure do |config|
+
+end

data/spec/support/test_files.rb

@@ -0,0 +1,25 @@
+def test_icon 
+  file = Tempfile.new('icon')
+  file.write("hello world")
+  file.rewind
+  file.unlink
+  file
+end
+
+def test_ssl_pair
+  key = OpenSSL::PKey::RSA.new(512)
+  name = OpenSSL::X509::Name.parse("CN=auralis/DC=topalis/DC=com")
+  cert = OpenSSL::X509::Certificate.new()
+  cert.version = 2
+  cert.serial = 0
+  cert.not_before = Time.new()
+  cert.not_after = cert.not_before + (60*60*24*365)
+  cert.public_key = key.public_key
+  cert.subject = name
+
+  # Sign cert
+  cert.issuer = name
+  cert.sign(key, OpenSSL::Digest::SHA1.new())
+
+  {certificate: cert, key: key}
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: grocer-pushpackager
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kurt Nelson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-14 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !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: 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'
+description: Builds push packages for OS X Mavericks web notifications
+email:
+- kurtisnelson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grocer-pushpackager.gemspec
+- lib/grocer/pushpackager.rb
+- lib/grocer/pushpackager/icon.rb
+- lib/grocer/pushpackager/icon_set.rb
+- lib/grocer/pushpackager/package.rb
+- lib/grocer/pushpackager/version.rb
+- lib/grocer/pushpackager/website.rb
+- spec/package_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_files.rb
+homepage: https://github.com/grocer/grocer-pushpackager
+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: To use push notifications to Safari/OS X with the APN service, you must build
+  a signed push package that is generated by your web server for every user. This
+  gem handles building that package.
+test_files:
+- spec/package_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_files.rb