power-passbook 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56a647ed28b15ef2aa1d17912347f569760c4f08
+  data.tar.gz: 7f9b1d96fd075d70f334ce543028e237897f94e0
+SHA512:
+  metadata.gz: 09d55639d69ac5d073a1122803df3a978572e0064ceb292fa75260e034bb49aec81557f9be141b750ca40b86aba1ad7176f2c0b668cf158757cfb26a1edf282a
+  data.tar.gz: 4ab347f309dbc0bb3cf2fac18cbc3aaef328ae0bfeb829333fd13a5de2e340ff2ed06d02e3ce0744cead6e51717b4cad94a50b88d2af20034964a1b6aab75db7

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Max Power
+
+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,68 @@
+# Passbook
+
+This is inspired by [Passifier](https://github.com/paperlesspost/passifier) which i couldn't get to run with p12 signing. So here is my take on iOS Passbook passes. It's used here: https://chefcards.herokuapp.com
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'power-passbook', github: 'max-power/passbook'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+First setup Signing:
+
+    signer = Passbook::Authority.new(File.read("/path/to/certificate.p12"), "secret-password")
+
+The basic usage is:
+  
+    pass = Passbook::PKPass.new(pass_specifications, pass_assets, signer)
+    pass.to_file("my/path/to/the/pass.pkpass")
+    pass.to_s
+    pass.content_type  # "application/vnd.apple.pkpass"
+
+Pass specifications is a hash that should match the [Apple Passbook Format Reference](https://developer.apple.com/library/ios/documentation/UserExperience/Reference/PassKit_Bundle/Chapters/TopLevel.html).
+
+    pass_specifications = {
+      "formatVersion"      => 1,
+      "passTypeIdentifier" => "pass.com.flycheap.boardingpass",
+      "teamIdentifier"     => "XXXXXXXX",
+      "organizationName"   => "XXXXXXXX",
+      "labelColor"         => "#ffffff",
+      "backgroundColor"    => "#618d04",
+      "foregroundColor"    => "#ffffff",
+      "serialNumber"       => "123",
+      "logoText"           => "Hi",
+      ...
+    }
+    
+The assets parameter is a hash with filenames as keys and local or remote paths to the file as value.
+See the [Apple Pass Design and Creation guidelines](https://developer.apple.com/library/ios/documentation/UserExperience/Conceptual/PassKit_PG/Chapters/Creating.html#//apple_ref/doc/uid/TP40012195-CH4-SW45) 
+to see which files are used for the different pass types.
+
+    pass_assets = {
+      "background.png"    => "assets/background.png",
+      "background@2x.png" => "assets/background@2x.png",
+      "icon.png"          => "assets/icon.png",
+      "icon@2x.png"       => "assets/icon@2x.png",
+      "logo.png"          => "http://i.imgur.com/WLUf6.png",
+      "logo@2x.png"       => "http://i.imgur.com/mOpQo.png",
+      "thumbnail.png"     => "assets/thumbnail.png",
+      "thumbnail@2x.png"  => "assets/thumbnail@2x.png"
+    }
+
+## See Also
+
+There is also a very tiny (60 LOC) version available here: https://gist.github.com/max-power/9262053
+
+## Contributing
+
+1. Fork it ( http://github.com/max-power/passbook/fork )
+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,19 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.libs << 'spec'
+end
+
+desc "Run tests"
+task :default => :test
+
+desc "Run console"
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'passbook'
+  ARGV.clear
+  IRB.start
+end

data/lib/passbook.rb

@@ -0,0 +1,47 @@
+require "passbook/version"
+require "passbook/pk_pass"
+require "openssl"
+
+module Passbook
+  class Authority
+    def initialize(certificate, password)
+      @pk12 = OpenSSL::PKCS12.new(certificate, password)
+      @flag = OpenSSL::PKCS7::BINARY | OpenSSL::PKCS7::DETACHED
+      @wwdr = OpenSSL::X509::Certificate.new(wwdr_certificate)
+    end
+  
+    def sign(content)
+      OpenSSL::PKCS7.sign(@pk12.certificate, @pk12.key, content, [@wwdr], @flag).to_der
+    end
+    
+    def wwdr_certificate
+      <<-EOF.gsub /^\s+/, ""
+      -----BEGIN CERTIFICATE-----
+      MIIEIzCCAwugAwIBAgIBGTANBgkqhkiG9w0BAQUFADBiMQswCQYDVQQGEwJVUzET
+      MBEGA1UEChMKQXBwbGUgSW5jLjEmMCQGA1UECxMdQXBwbGUgQ2VydGlmaWNhdGlv
+      biBBdXRob3JpdHkxFjAUBgNVBAMTDUFwcGxlIFJvb3QgQ0EwHhcNMDgwMjE0MTg1
+      NjM1WhcNMTYwMjE0MTg1NjM1WjCBljELMAkGA1UEBhMCVVMxEzARBgNVBAoMCkFw
+      cGxlIEluYy4xLDAqBgNVBAsMI0FwcGxlIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVs
+      YXRpb25zMUQwQgYDVQQDDDtBcHBsZSBXb3JsZHdpZGUgRGV2ZWxvcGVyIFJlbGF0
+      aW9ucyBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTCCASIwDQYJKoZIhvcNAQEBBQAD
+      ggEPADCCAQoCggEBAMo4VKbLVqrIJDlI6Yzu7F+4fyaRvDRTes58Y4Bhd2RepQcj
+      tjn+UC0VVlhwLX7EbsFKhT4v8N6EGqFXya97GP9q+hUSSRUIGayq2yoy7ZZjaFIV
+      PYyK7L9rGJXgA6wBfZcFZ84OhZU3au0Jtq5nzVFkn8Zc0bxXbmc1gHY2pIeBbjiP
+      2CsVTnsl2Fq/ToPBjdKT1RpxtWCcnTNOVfkSWAyGuBYNweV3RY1QSLorLeSUheHo
+      xJ3GaKWwo/xnfnC6AllLd0KRObn1zeFM78A7SIym5SFd/Wpqu6cWNWDS5q3zRinJ
+      6MOL6XnAamFnFbLw/eVovGJfbs+Z3e8bY/6SZasCAwEAAaOBrjCBqzAOBgNVHQ8B
+      Af8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUiCcXCam2GGCL7Ou6
+      9kdZxVJUo7cwHwYDVR0jBBgwFoAUK9BpR5R2Cf70a40uQKb3R01/CF4wNgYDVR0f
+      BC8wLTAroCmgJ4YlaHR0cDovL3d3dy5hcHBsZS5jb20vYXBwbGVjYS9yb290LmNy
+      bDAQBgoqhkiG92NkBgIBBAIFADANBgkqhkiG9w0BAQUFAAOCAQEA2jIAlsVUlNM7
+      gjdmfS5o1cPGuMsmjEiQzxMkakaOY9Tw0BMG3djEwTcV8jMTOSYtzi5VQOMLA6/6
+      EsLnDSG41YDPrCgvzi2zTq+GGQTG6VDdTClHECP8bLsbmGtIieFbnd5G2zWFNe8+
+      0OJYSzj07XVaH1xwHVY5EuXhDRHkiSUGvdW0FY5e0FmXkOlLgeLfGK9EdB4ZoDpH
+      zJEdOusjWv6lLZf3e7vWh0ZChetSPSayY6i0scqP9Mzis8hH4L+aWYP62phTKoL1
+      fGUuldkzXfXtZcwxN8VaBOhr4eeIA0p1npsoy0pAiGVDdd3LOiUjxZ5X+C7O0qmS
+      XnMuLyV1FQ==
+      -----END CERTIFICATE-----
+      EOF
+    end
+  end
+end

data/lib/passbook/archive.rb

@@ -0,0 +1,15 @@
+require "zip"
+
+module Passbook
+  module Archive
+    module_function
+    
+    def zip(*files)
+      Zip::OutputStream.write_buffer do |zip|
+        files.flatten.compact.each do |file|
+          zip.put_next_entry(file.filename) && zip.write(file.content)
+        end
+      end
+    end
+  end
+end

data/lib/passbook/assets.rb

@@ -0,0 +1,10 @@
+require "passbook/static_file"
+require "passbook/remote_file"
+
+module Passbook
+  class Assets < Array
+    def initialize(dict)
+      super dict.map { |n,p| (p =~ %r[^https?://\S+] ? RemoteFile : StaticFile).new(n,p) }
+    end
+  end
+end

data/lib/passbook/manifest.rb

@@ -0,0 +1,24 @@
+require "digest/sha1"
+require "json"
+
+module Passbook
+  class Manifest
+    def initialize(*files)
+      @files = files.flatten.compact
+    end
+    
+    def filename
+      "manifest.json"
+    end
+    
+    def content
+      @content ||= dictionary.to_json
+    end
+    
+    def dictionary
+      @files.each_with_object({}) do |file, dict|
+        dict[file.filename] = Digest::SHA1.hexdigest(file.content)
+      end
+    end
+  end
+end

data/lib/passbook/pass.rb

@@ -0,0 +1,17 @@
+require "json"
+
+module Passbook
+  class Pass
+    def initialize(specs)
+      @specs = specs
+    end
+    
+    def filename
+      "pass.json"
+    end
+    
+    def content
+      @content ||= @specs.to_json
+    end
+  end
+end

data/lib/passbook/pk_pass.rb

@@ -0,0 +1,28 @@
+require "passbook/pass"
+require "passbook/assets"
+require "passbook/manifest"
+require "passbook/signature"
+require "passbook/archive"
+
+module Passbook
+  class PKPass
+    def initialize(specs, assets, authority)
+      @pass      = Pass.new(specs)
+      @assets    = Assets.new(assets)
+      @manifest  = Manifest.new(@pass, @assets)
+      @signature = Signature.new(@manifest, authority)
+    end
+    
+    def content_type
+      "application/vnd.apple.pkpass"
+    end
+    
+    def to_s
+      Archive.zip(@pass, @assets, @manifest, @signature).string
+    end
+    
+    def to_file(path)
+      File.write(path, to_s)
+    end
+  end
+end

data/lib/passbook/remote_file.rb

@@ -0,0 +1,15 @@
+require "net/http"
+
+module Passbook
+  class RemoteFile
+    attr_reader :filename
+
+    def initialize(name, uri)
+      @filename, @uri = name, URI(uri)
+    end
+    
+    def content
+      @content ||= Net::HTTP.get(@uri)
+    end
+  end
+end

data/lib/passbook/signature.rb

@@ -0,0 +1,15 @@
+module Passbook
+  class Signature
+    def initialize(manifest, authority)
+      @manifest, @authority = manifest, authority
+    end
+    
+    def filename
+      "signature"
+    end
+    
+    def content
+      @content ||= @authority.sign(@manifest.content)
+    end
+  end
+end

data/lib/passbook/static_file.rb

@@ -0,0 +1,15 @@
+require "pathname"
+
+module Passbook
+  class StaticFile
+    attr_reader :filename
+    
+    def initialize(name, path)
+      @filename, @path = name, Pathname(path)
+    end
+    
+    def content
+      @content ||= @path.read
+    end
+  end
+end

data/lib/passbook/version.rb

@@ -0,0 +1,3 @@
+module Passbook
+  VERSION = "0.0.2"
+end

data/passbook.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'passbook/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "power-passbook"
+  spec.version       = Passbook::VERSION
+  spec.authors       = ["Max Power"]
+  spec.email         = ["kevin.melchert@gmail.com"]
+  spec.summary       = %q{Passbook pass generator.}
+  spec.description   = %q{Passbook pass generator.}
+  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.add_dependency "rubyzip", "~> 1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/spec/assets_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Passbook::Assets do
+  before do
+    data = {
+      "background.png" => "assets/background.png",
+      "background@2x.png" => "assets/background@2x.png",
+      "icon.png" => "assets/icon.png",
+      "icon@2x.png" => "assets/icon@2x.png",
+      "logo.png" => "http://i.imgur.com/WLUf6.png",
+      "logo@2x.png" => "http://i.imgur.com/mOpQo.png",
+      "thumbnail.png" => "assets/thumbnail.png",
+      "thumbnail@2x.png" => "assets/thumbnail@2x.png"
+    }
+    @assets = Passbook::Assets.new(data)
+  end
+  
+  it "should only contain remote or static files" do
+    @assets.all? { |a| ['Passbook::StaticFile', 'Passbook::RemoteFile'].include?(a.class.name) }.must_equal true
+  end
+  
+  it "should have 1 member" do
+    @assets.length.must_equal 8
+  end
+end

data/spec/files/test.txt

@@ -0,0 +1 @@
+TEST-1-2-3

data/spec/manifest_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Passbook::Manifest do
+  before do
+    @manifest = Passbook::Manifest.new({}, {})
+  end
+  
+  it "should have a filename" do
+    @manifest.filename.must_equal "manifest.json"
+  end
+  
+  it "should sign a string" do
+    @manifest.sign('x').must_equal "11f6ad8ec52a2984abaafd7c3b516503785c2072"
+  end
+  
+  # it "should have content" do
+  #   @file.content.must_equal 'TEST-1-2-3'
+  # end
+end

data/spec/pass_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Passbook::Pass do
+  before do
+    @pass = Passbook::Pass.new({ a: '123' }, { serialNumber: 'xtc1001' })
+  end
+  
+  it "should have a filename" do
+    @pass.filename.must_equal 'pass.json'
+  end
+  
+  it "should have content" do
+    @pass.content.must_equal %Q[{"a":"123","serialNumber":"xtc1001"}]
+  end
+end

data/spec/pk_pass_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Passbook::PKPass do
+  before do
+    @pass = Passbook::PKPass.new({},{})
+  end
+  
+  it "should have the 'vnd.apple.pkpass' content_type" do
+    @pass.content_type.must_equal 'application/vnd.apple.pkpass'
+  end
+  
+end

data/spec/remote_file_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Passbook::RemoteFile do
+  before do
+    @file = Passbook::RemoteFile.new('test.txt', 'http://www.last.fm/robots.txt')
+  end
+  
+  it "should have a filename" do
+    @file.filename.must_equal 'test.txt'
+  end
+  
+  it "should have content" do
+    @file.content.must_equal 'User-Agent: *
+Disallow: /music?
+Disallow: /widgets/radio?
+
+Disallow: /affiliate/
+Disallow: /affiliate_redirect.php
+Disallow: /affiliate_sendto.php
+Disallow: /affiliatelink.php
+Disallow: /campaignlink.php
+Disallow: /delivery.php
+
+Disallow: /music/+noredirect/
+Disallow: /user/*/library/music/
+Disallow: /*/+news/*/visit
+Disallow: /*/+wiki/diff
+
+# AJAX content
+Disallow: /search/autocomplete
+Disallow: /template
+Disallow: /ajax
+Disallow: /user/*/tasteomatic
+
+# Ads metastructure
+Disallow: /8264
+
+Disallow: /harming/humans
+Disallow: /ignoring/human/orders
+Disallow: /harm/to/self
+
+Allow: /
+
+Sitemap: http://www.last.fm/sitemap-index.xml
+'
+  end
+end

data/spec/signature_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Passbook::Signature do
+  before do
+    @sig = Passbook::Signature.new({})
+  end
+  
+  it "should have a filename" do
+    @sig.filename.must_equal 'signature'
+  end
+  
+  it "should have content" do
+#    @sig.content.must_equal 'TEST-1-2-3'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+require 'rubygems'
+require 'bundler/setup'
+
+require 'minitest/autorun'
+require 'minitest/spec'
+
+require 'passbook'
+
+Dummy = Struct.new(:filename, :content)

data/spec/static_file_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Passbook::StaticFile do
+  before do
+    @file = Passbook::StaticFile.new('icon.png', Pathname.new(__FILE__).dirname + 'files/test.txt')
+  end
+  
+  it "should have a filename" do
+    @file.filename.must_equal 'icon.png'
+  end
+  
+  it "should have content" do
+    @file.content.must_equal 'TEST-1-2-3'
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: power-passbook
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Max Power
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: minitest
+  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: Passbook pass generator.
+email:
+- kevin.melchert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/passbook.rb
+- lib/passbook/archive.rb
+- lib/passbook/assets.rb
+- lib/passbook/manifest.rb
+- lib/passbook/pass.rb
+- lib/passbook/pk_pass.rb
+- lib/passbook/remote_file.rb
+- lib/passbook/signature.rb
+- lib/passbook/static_file.rb
+- lib/passbook/version.rb
+- passbook.gemspec
+- spec/assets_spec.rb
+- spec/files/test.txt
+- spec/manifest_spec.rb
+- spec/pass_spec.rb
+- spec/pk_pass_spec.rb
+- spec/remote_file_spec.rb
+- spec/signature_spec.rb
+- spec/spec_helper.rb
+- spec/static_file_spec.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.2.2
+signing_key: 
+specification_version: 4
+summary: Passbook pass generator.
+test_files:
+- spec/assets_spec.rb
+- spec/files/test.txt
+- spec/manifest_spec.rb
+- spec/pass_spec.rb
+- spec/pk_pass_spec.rb
+- spec/remote_file_spec.rb
+- spec/signature_spec.rb
+- spec/spec_helper.rb
+- spec/static_file_spec.rb