passbook-ruby 0.0.5

data/lib/rails/generators/passbook/pkpass/templates/initializer.rb

@@ -0,0 +1,27 @@
+
+#  Copyright 2012 Xtreme Labs
+
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+
+
+Passbook::Config.instance.add_pkpass do |passbook|
+  passbook.pass_config["<%= pass_type_id %>"]={
+                              "cert_path"=>"<%= cert_path.blank? ? "#{Rails.root}/data/certificates/#{pass_type_id}.p12" : cert_path %>",
+                              "cert_password"=>"<%= cert_password %>",
+                              "template_path"=>"<%= "#{Rails.root}/data/templates/#{pass_type_id}" %>",
+                              "class"=>"<%= class_name %>"
+                            }
+
+end

data/lib/rails/generators/passbook/pkpass/templates/migration.rb

@@ -0,0 +1,29 @@
+
+#  Copyright 2012 Xtreme Labs
+
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+
+
+class Create<%= class_name.pluralize %> < ActiveRecord::Migration
+  def change
+    create_table :<%= plural_name %> do |t|
+      t.string :serial_number
+      t.string :authentication_token
+      t.string :card_id
+
+      t.timestamps
+    end
+  end
+end

data/lib/rails/generators/passbook/pkpass/templates/model.rb

@@ -0,0 +1,54 @@
+
+#  Copyright 2012 Xtreme Labs
+
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+
+
+class <%= class_name %> < ActiveRecord::Base
+  attr_protected :serial_number, :authentication_token
+  attr_accessible :card_id
+  before_create :set_pass_fields
+
+  def set_pass_fields
+    self.authentication_token = Base64.urlsafe_encode64(SecureRandom.base64(36))
+    self.serial_number||= Base64.urlsafe_encode64(SecureRandom.base64(36))
+  end
+
+  def self.update_or_create params
+    <%= plural_name.singularize %>_pass = find_by_card_id params[:card_id]
+    <%= plural_name.singularize %>_pass ||=new
+    params.slice(*attr_accessible[:default].map(&:to_sym)).each do |attr, val|
+      <%= plural_name.singularize %>_pass.send :"#{attr}=", val
+    end
+    <%= plural_name.singularize %>_pass.save!
+    <%= plural_name.singularize %>_pass
+  end
+
+  def check_for_updates
+
+  end
+
+  def update_pass pkpass
+    update_json pkpass.json
+  end
+
+  def update_json pass_json
+    pass_json['authenticationToken'] = authentication_token
+    pass_json['serialNumber'] = serial_number
+    #don't forget to change the URL to whatever address your server is at
+    pass_json['webServiceURL'] = "http://192.168.x.x:3000"
+    #add more customization to your passbook's JSON right here
+  end
+end

data/lib/rails/generators/passbook/pkpass/templates/pass.json

@@ -0,0 +1,38 @@
+{
+  "formatVersion" : 1,
+  "passTypeIdentifier" : "<%= pass_type_id %>",
+  "serialNumber" : "12345",
+  "teamIdentifier" : "<%= team_id %>",
+  "webServiceURL" : "http://192.168.91.151:3000",
+  "authenticationToken" : "",
+  "barcode" : {
+    "message" : "34534636",
+    "format" : "PKBarcodeFormatPDF417",
+    "messageEncoding" : "iso-8859-1"
+  },
+  "organizationName" : "ACME Inc.",
+  "description" : "",
+  "logoText" : "ACME",
+  "foregroundColor" : "rgb(22, 55, 110)",
+  "backgroundColor" : "rgb(50, 91, 185)",
+  "coupon" : {
+    "headerFields" : [
+      {
+        "label" : "TEST",
+        "key" : "test",
+        "value" : "#1",
+        "changeMessage" : "Test number changed to %@."
+      }
+    ],
+    "primaryFields" : [
+      {
+        "key" : "passbook",
+        "label" : "",
+        "value" : "<%= class_name %>"
+      }
+    ],
+    "secondaryFields" : [],
+    "auxiliaryFields" : [],
+    "backFields" : []
+  }
+}

data/spec/config_spec.rb

@@ -0,0 +1,45 @@
+
+#  Copyright 2012 Xtreme Labs
+
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+
+
+require 'spec_helper'
+
+describe Passbook::Config do
+  it "should throw ArgumentError because wwdr_intermediate_certificate_path is missing"  do
+    expect {Passbook::Config.instance.configure {}}.to raise_error(ArgumentError)
+  end
+
+  it "should throw ArgumentError because cert_path is missing" do
+    expect{ Passbook::Config.instance.add_pkpass do |passbook|
+      passbook.wwdr_intermediate_certificate_path = "test"
+      passbook.wwdr_certificate = OpenSSL::X509::Certificate.new
+      passbook.pass_config["pass.com.acme"] = {"template_path"=>"tmp"}
+    end}.to raise_error(ArgumentError)
+  end
+
+  it "should throw ArgumentError because cert_password is missing" do
+    expect{ Passbook::Config.instance.add_pkpass do |passbook|
+      passbook.wwdr_intermediate_certificate_path = "test"
+      passbook.wwdr_certificate = OpenSSL::X509::Certificate.new
+      passbook.pass_config["pass.com.acme"] = {
+                                                "cert_path"=>"tmp"
+                                              }
+    end}.to raise_error(ArgumentError)
+  end
+
+end
+

data/spec/data/templates/pass.com.acme/pass.json

@@ -0,0 +1,26 @@
+{
+  "formatVersion" : 1,
+  "passTypeIdentifier" : "pass.com.acme",
+  "serialNumber" : "werwer",
+  "teamIdentifier" : "sdfsdfsdf",
+  "webServiceURL" : "https://acme.com/passes/",
+  "authenticationToken" : "werwfdsfd",
+  "barcode" : {
+    "message" : "",
+    "format" : "PKBarcodeFormatPDF417",
+    "messageEncoding" : "iso-8859-1"
+  },
+  "organizationName" : "Acme",
+  "description" : "test",
+  "logoText" : "test",
+  "foregroundColor" : "rgb(0, 0, 0)",
+  "backgroundColor" : "rgb(0, 0, 0)",
+  "boardingPass" : {
+    "transitType" : "PKTransitTypeAir",
+    "headerFields" : [],
+    "primaryFields" : [],
+    "secondaryFields" : [],
+    "auxiliaryFields" : [],
+    "backFields" : []
+  }
+}

data/spec/pkpass_spec.rb

@@ -0,0 +1,117 @@
+
+#  Copyright 2012 Xtreme Labs
+
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+
+
+require 'spec_helper'
+require 'json'
+
+
+RSpec.configure do |c|
+  c.include Helpers
+end
+
+describe Passbook::Pkpass do
+  before :all do
+    Passbook::Config.instance.configure do |passbook|
+      passbook.wwdr_certificate = OpenSSL::X509::Certificate.new
+    end
+
+    Passbook::Config.instance.add_pkpass do |passbook|
+      template_path =  "#{Dir.pwd}/spec/data/templates"
+      cert_path = "#{Dir.pwd}/spec/data/certificates"
+      passbook.pass_config["pass.com.acme"]={
+                                  "cert_path"=>"#{cert_path}/pass.com.acme.p12",
+                                  "cert_password"=>"test",
+                                  "template_path"=>"#{template_path}/pass.com.acme",
+                                  "p12_certificate"=>create_p12
+                                }
+      passbook.wwdr_intermediate_certificate_path = "#{Dir.pwd}/spec/data/certificates/wwdr.pem"
+    end
+  end
+
+  before :each do
+    @pass = Passbook::Pkpass.new("pass.com.acme", "test")
+  end
+
+
+  it "should throw ArgumentError because there is no config for 'test'" do
+    expect {Passbook::Pkpass.new("test", "test")}.to raise_error(ArgumentError, /configuration for test/)
+  end
+
+  it "should make an instance of Pkpass" do
+    expect {Passbook::Pkpass.new("pass.com.acme", "test")}.to_not raise_error
+  end
+
+  it "should have the added file in zip file" do
+    @pass.add_file "andrei.png", "haha"
+    pkpass_io = @pass.package
+    check_file_in_zip(pkpass_io, "andrei.png").should be_true
+  end
+
+  it "should have the added file in zip file(in a folder)" do
+    @pass.add_file "fr.lproj/andrei.png", "haha"
+    pkpass_io = @pass.package
+    check_file_in_zip(pkpass_io, "fr.lproj/andrei.png").should be_true
+  end
+
+  it "should add an entry in the right pass.strings file" do
+    @pass.add_translation_string "yes", "qui", "fr"
+    pass_strings = file_from_zip(@pass.package, "fr.lproj/pass.strings")
+    pass_strings.should_not be_nil
+    pass_strings.should match /\"yes\" = \"qui\";/
+  end
+
+  it "should only append to strings file" do
+    @pass.add_file "fr.lproj/pass.strings", "\"not\" = \"not\";"
+    @pass.add_translation_string "yes", "qui", "fr"
+    pass_strings = file_from_zip(@pass.package, "fr.lproj/pass.strings")
+    pass_strings.should_not be_nil
+    pass_strings.should match /\"not\" = \"not\";/
+    pass_strings.should match /\"yes\" = \"qui\";/
+  end
+
+  it "should include all the files from template_path" do
+    pkpass_io = @pass.package
+    Dir.glob(@pass.config["template_path"]+"/**/**").each do |file|
+      next if File.directory? file
+      filename = Pathname.new(file).relative_path_from(Pathname.new(@pass.config['template_path']))
+      check_file_in_zip(pkpass_io, filename.to_s).should be_true
+    end
+  end
+
+  it "should include manifest.json" do
+    check_file_in_zip(@pass.package, "manifest.json").should be_true
+  end
+
+  it "should have all the files in manifest.json and none more" do
+    files_json = JSON.parse(file_from_zip(@pass.package, "manifest.json"))
+    Dir.glob(@pass.config["template_path"]+"/**/**").each do |file|
+      next if File.directory? file
+      filename = Pathname.new(file).relative_path_from(Pathname.new(@pass.config['template_path'])).to_s
+      if files_json.include? filename
+        files_json.delete filename
+      else
+        fail
+      end
+    end
+    files_json.should be_empty
+  end
+
+  it "should have a signature" do
+    check_file_in_zip(@pass.package, "signature").should be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,82 @@
+
+#  Copyright 2012 Xtreme Labs
+
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+require "rails"
+require "rails/test_help"
+
+require_relative '../lib/passbook-ruby'
+require_relative '../lib/passbook/config'
+require_relative '../lib/passbook/pkpass'
+
+
+module Helpers
+
+  def zip_io zip_file_io
+    File.open("test.zip", 'w') do |file|
+      zip_file_io.rewind
+      file.write zip_file_io.sysread.force_encoding("UTF-8")
+    end
+    Zip::ZipInputStream::open("test.zip")
+  end
+
+  def file_from_zip zip_file_io, filename
+    io = zip_io zip_file_io
+    while (entry = io.get_next_entry) do
+      return io.read if entry.name == filename
+    end
+    nil
+  end
+
+  def check_file_in_zip zip_file_io, filename
+    io = zip_io zip_file_io
+    while (entry = io.get_next_entry) do
+      return true if entry.name == filename
+    end
+    false
+
+    # def zip_file_io.path
+    #   'bypass_rubyzip_issue'
+    # end
+    # puts "We got #{zip_file_io.size}"
+
+    # Zip::ZipInputStream::open_buffer(zip_file_io) do |io|
+    #   entry = io.get_next_entry
+    #   # while (entry = io.get_next_entry) do
+    #   #     puts "entry: #{entry.name}"
+    #   # end
+    # end
+  end
+
+  def create_p12
+    root_key = OpenSSL::PKey::RSA.new 2048 # the CA's public/private key
+    root_ca = OpenSSL::X509::Certificate.new
+    root_ca.version = 2 # cf. RFC 5280 - to make it a "v3" certificate
+    root_ca.serial = 1
+    root_ca.subject = OpenSSL::X509::Name.parse "/DC=org/DC=ruby-lang/CN=Ruby CA"
+    root_ca.issuer = root_ca.subject # root CA's are "self-signed"
+    root_ca.public_key = root_key.public_key
+    root_ca.not_before = Time.now
+    root_ca.not_after = root_ca.not_before + 2 * 365 * 24 * 60 * 60 # 2 years validity
+    ef = OpenSSL::X509::ExtensionFactory.new
+    ef.subject_certificate = root_ca
+    ef.issuer_certificate = root_ca
+    root_ca.add_extension(ef.create_extension("basicConstraints","CA:TRUE",true))
+    root_ca.add_extension(ef.create_extension("keyUsage","keyCertSign, cRLSign", true))
+    root_ca.add_extension(ef.create_extension("subjectKeyIdentifier","hash",false))
+    root_ca.add_extension(ef.create_extension("authorityKeyIdentifier","keyid:always",false))
+    root_ca.sign(root_key, OpenSSL::Digest::SHA256.new)
+    OpenSSL::PKCS12.create("test", "test", root_key, root_ca)
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: passbook-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+  prerelease: 
+platform: ruby
+authors:
+- Andrei Dinin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70284296286940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70284296286940
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: &70284296285700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70284296285700
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70284296284320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70284296284320
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70284296282360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70284296282360
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70284296281680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70284296281680
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70284296258280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70284296258280
+description: Passbook pkpass creation and management for Ruby projects
+email: andrei.dinin@xtremelabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/passbook/logs_controller.rb
+- app/controllers/passbook/passes_controller.rb
+- app/controllers/passbook/registrations_controller.rb
+- app/models/passbook/registration.rb
+- config/routes.rb
+- lib/passbook/config.rb
+- lib/passbook/engine.rb
+- lib/passbook/pkpass.rb
+- lib/passbook-ruby.rb
+- lib/rails/generators/passbook/config/config_generator.rb
+- lib/rails/generators/passbook/config/templates/initializer.rb
+- lib/rails/generators/passbook/config/templates/migration.rb
+- lib/rails/generators/passbook/pkpass/pkpass_generator.rb
+- lib/rails/generators/passbook/pkpass/templates/icon.png
+- lib/rails/generators/passbook/pkpass/templates/icon@2x.png
+- lib/rails/generators/passbook/pkpass/templates/initializer.rb
+- lib/rails/generators/passbook/pkpass/templates/migration.rb
+- lib/rails/generators/passbook/pkpass/templates/model.rb
+- lib/rails/generators/passbook/pkpass/templates/pass.json
+- spec/config_spec.rb
+- spec/data/templates/pass.com.acme/pass.json
+- spec/pkpass_spec.rb
+- spec/spec_helper.rb
+- README.md
+- LICENSE
+homepage: https://github.com/xtremelabs/xl-passbook-ruby/
+licenses: []
+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.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: passbook-ruby
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Passbook pkpass creation and management for Ruby projects
+test_files: []