passbook-ruby 0.0.5

data/app/models/passbook/registration.rb

@@ -0,0 +1,24 @@
+
+#  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.
+
+
+
+
+module Passbook
+  class Registration < ActiveRecord::Base
+    set_table_name "passbook_registrations"
+    attr_accessible :device_id, :pass_type_id, :push_token, :serial_number, :uuid
+  end
+end

data/config/routes.rb

@@ -0,0 +1,36 @@
+
+#  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.
+
+
+
+
+if Passbook::Config.instance.enable_routes
+  Rails.application.routes.draw do
+    get "/v1/passes/:pass_type_id/:serial_number" => "Passbook::passes#get_pass", :constraints => { :pass_type_id => /[^\/]+/ }
+
+    post "/v1/devices/:device_id/registrations/:pass_type_id/:serial_number" => "Passbook::registrations#create", :constraints => { :pass_type_id => /[^\/]+/ }
+    delete "/v1/devices/:device_id/registrations/:pass_type_id/:serial_number" => "Passbook::registrations#delete", :constraints => { :pass_type_id => /[^\/]+/ }
+    get "/v1/devices/:device_id/registrations/:pass_type_id" =>"Passbook::registrations#updatable", :constraints => { :pass_type_id => /[^\/]+/ }
+
+    post "/v1/log" => "Passbook::logs#log"
+  end
+end
+
+
+
+
+
+
+

data/lib/passbook-ruby.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 "passbook/config"
+require "passbook/pkpass"
+require "passbook/engine"
+
+require "action_controller"
+Mime::Type.register 'application/vnd.apple.pkpass', :pkpass
+
+ActionController::Renderers.add :pkpass do |obj, options|
+  pkpass = Passbook::Pkpass.new Passbook.class_name_to_pass_type_id(obj.class.to_s), obj.serial_number
+  obj.update_pass pkpass
+  pkpass_io = pkpass.package
+  response.headers["last-modified"] = obj.updated_at.strftime("%Y-%m-%d %H:%M:%S")
+  send_data(pkpass_io.sysread, :type => 'application/vnd.apple.pkpass', :disposition=>'inline', :filename=>"#{obj.serial_number}.pkpass")
+end
+
+module Passbook
+  def self.pass_type_id_to_class pass_type_id
+    Passbook::Config.instance.pass_config[pass_type_id]['class'].constantize
+  end
+
+  def self.class_name_to_pass_type_id class_name
+    Passbook::Config.instance.pass_config.each do |pass_type_id, config|
+      return pass_type_id if config['class']==class_name
+    end
+  end
+end
+

data/lib/passbook/config.rb

@@ -0,0 +1,74 @@
+
+#  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 'fileutils'
+require 'singleton'
+
+module Passbook
+  class Config
+    include Singleton
+    attr_accessor :pass_config, :wwdr_intermediate_certificate_path, :wwdr_certificate, :preload_template, :enable_routes
+
+    def configure
+      self.pass_config = Hash.new unless self.pass_config
+      yield self
+      read_wwdr_certificate
+    end
+
+    def add_pkpass
+      self.pass_config = Hash.new unless self.pass_config
+      yield self
+      self.preload_template ||= ::Rails.env.production? if defined? ::Rails
+      read_templates if self.preload_template
+      read_p12_certificates
+    end
+
+    def read_templates
+      self.pass_config.each do |pass_type_id, config|
+        raise(ArgumentError, "Please specify a template_path in your configuration (in initializer)") unless config['template_path']
+        config['files']||= load_file config['template_path']
+      end
+    end
+
+    def load_files path
+      files = {}
+      Dir.glob(path+"/**/**").each do |file_path|
+        next if File.directory? file_path
+        filename = Pathname.new(file_path).relative_path_from(Pathname.new(path))
+        file = File.open(file_path, "rb")
+        files[filename.to_s] = File.read(file)
+      end
+      files
+    end
+
+    def read_p12_certificates
+      pass_config.each do |pass_type_id, config|
+        raise(ArgumentError, "Please specify cert_path (certificate path) in your configuration (in initializer)") unless config['cert_path'] && !config['cert_path'].blank?
+        raise(ArgumentError, "Please specify cert_password (certificate password) in your configuration (in initializer)") unless config['cert_password']
+        config['p12_certificate'] ||=  OpenSSL::PKCS12::new(File.read(config['cert_path']), config['cert_password'])
+      end
+    end
+
+    def read_wwdr_certificate
+      raise(ArgumentError, "Please specify the WWDR Intermediate certificate in your initializer") unless self.wwdr_intermediate_certificate_path
+      self.wwdr_certificate||= OpenSSL::X509::Certificate.new(File.read(self.wwdr_intermediate_certificate_path))
+    end
+
+  end
+end
+

data/lib/passbook/engine.rb

@@ -0,0 +1,23 @@
+
+#  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.
+
+
+
+
+module Passbook
+  class Engine < Rails::Engine
+  end
+end
+

data/lib/passbook/pkpass.rb

@@ -0,0 +1,111 @@
+
+#  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 'digest/sha1'
+require 'json'
+require 'openssl'
+require 'zip/zip'
+require 'zip/zipfilesystem'
+
+module Passbook
+  class Pkpass
+    attr_accessor :files, :translations, :json, :pass_type_id, :serial_number,  :config
+
+    def initialize(pass_type_id, serial_number)
+      self.pass_type_id = pass_type_id
+      self.serial_number = serial_number
+      self.translations = Hash.new
+      raise(ArgumentError, "Don't forget to run the generator to create the initializer") unless Config.instance.pass_config
+      self.config = Config.instance.pass_config[self.pass_type_id]
+      raise(ArgumentError, "Could not find configuration for #{self.pass_type_id}") unless self.config
+
+      if self.config.include? :files
+        self.files = self.config['files'].dup
+      else
+        self.files = Config.instance.load_files self.config['template_path']
+      end
+
+      if self.files.include? 'pass.json'
+        self.json = JSON.parse(self.files['pass.json'])
+      else
+        self.json = {}
+        puts "Warning: your template_path does not contain pass.json"
+      end
+    end
+
+    def add_file filename, content
+      self.files[filename] = content
+    end
+
+    def add_translation_string source, destination, language
+      self.translations[language] = Hash.new unless self.translations.include?(language)
+      self.translations[language][source] = destination
+    end
+
+    def package
+      #TODO: write a library that checks that all the right files are included in the package
+      #those requirements are going to be different depending on pass_type_id
+      self.write_json
+      self.write_translation_strings
+      self.generate_json_manifest
+      self.sign_manifest
+      self.compress_pass_file
+    end
+
+    def write_json
+      self.files['pass.json'] = JSON.pretty_generate(self.json)
+    end
+
+    def write_translation_strings
+      self.translations.each do |language, trans|
+        self.files["#{language}.lproj/pass.strings"] ||= ""
+        trans.each do |key, value|
+          #TODO: escape key and value
+          self.files["#{language}.lproj/pass.strings"] << "\n\"#{key}\" = \"#{value}\";"
+        end
+      end
+    end
+
+    def generate_json_manifest
+      manifest = {}
+      self.files.each do |filename, content|
+        manifest[filename] = Digest::SHA1.hexdigest(content)
+      end
+      self.files['manifest.json'] = JSON.pretty_generate(manifest)
+    end
+
+    def sign_manifest
+      flag = OpenSSL::PKCS7::BINARY|OpenSSL::PKCS7::DETACHED
+      signed = OpenSSL::PKCS7::sign(config['p12_certificate'].certificate, config['p12_certificate'].key, self.files['manifest.json'], [Config.instance.wwdr_certificate], flag)
+      self.files['signature'] = signed.to_der.force_encoding('UTF-8')
+    end
+
+    def compress_pass_file
+      stringio = Zip::ZipOutputStream::write_buffer do |z|
+        self.files.each do |filename, content|
+          z.put_next_entry filename
+          z.print content
+        end
+      end
+      stringio.set_encoding "binary"
+      stringio.rewind
+      stringio
+      # stringio.sysread
+    end
+  end
+end

data/lib/rails/generators/passbook/config/config_generator.rb

@@ -0,0 +1,36 @@
+
+#  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 'fileutils'
+
+module Passbook
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      argument :wwdr_certificate_path, type: :string, optional: true, banner: "Absolute path to your WWDR certification file"
+
+      desc 'Create Passbook initializer'
+      def create_initializer_file
+        path = "#{Rails.root}/data/certificates"
+        FileUtils.mkdir_p path if wwdr_certificate_path.blank? && !File.exists?(path)
+        template 'initializer.rb', File.join('config', 'initializers', 'passbook.rb')
+        template 'migration.rb', File.join('db', 'migrate', "#{Time.now.strftime("%Y%m%d%H%M%S")}_create_passbook_registrations.rb")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+
+#  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.configure do |passbook|
+  # Templates are preloaded in production and dynamically loaded in development by default
+  # You can control the behaviour by setting the 'preload_templates'
+  #
+  # passbook.preload_templates = true
+
+
+  # Enables the routes necessary for passes to be able to:
+  # 1) register with the server
+  # 2) log errors
+  # 3) list pkpasses to be updated
+  # 4) let passbook request for update
+  passbook.enable_routes = true
+
+
+  passbook.wwdr_intermediate_certificate_path= "<%= wwdr_certificate_path.blank? ? "#{Rails.root}/data/certificates/wwdr.pem":wwdr_certificate_path %>"
+end

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

@@ -0,0 +1,31 @@
+
+#  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 CreatePassbookRegistrations < ActiveRecord::Migration
+  def change
+    create_table :passbook_registrations do |t|
+      t.string :uuid
+      t.string :device_id
+      t.string :push_token
+      t.string :serial_number
+      t.string :pass_type_id
+
+      t.timestamps
+    end
+  end
+end

data/lib/rails/generators/passbook/pkpass/pkpass_generator.rb

@@ -0,0 +1,40 @@
+
+#  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.
+
+
+
+
+module Passbook
+  module Generators
+    class PkpassGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+      argument :pass_type_id, type: :string, default: 'pass.com.acme', optional: true, banner: "The Pass Type ID you registered at iOS Provisioning Portal"
+      argument :team_id, type: :string, optional: true, banner: "Team ID you got at the iOS Provisioning Portal when you registered the pass type id"
+      argument :cert_path, type: :string, optional: true, banner: "Absolute path to your pass.com.acme.p12 file"
+      argument :cert_password, type: :string, default: 'password', optional: true, banner: "Password for your P12 certificate"
+
+      desc 'Create and configure a model for a particular pkpass (ie. ticket)'
+      def create_initializer_file
+        template 'initializer.rb', File.join('config', 'initializers', "passbook_#{plural_name.singularize}.rb")
+        template 'model.rb', File.join('app', 'models', "#{plural_name.singularize}.rb")
+        route "get '/v1/passes/#{plural_name.singularize}' => 'Passbook::passes#get_pkpass', :defaults => { :pass_type_id => '#{pass_type_id}' }"
+        template 'migration.rb', File.join('db', 'migrate', "#{Time.now.strftime("%Y%m%d%H%M%S")}_create_#{plural_name}.rb")
+        template 'pass.json', File.join('data', 'templates', pass_type_id, "pass.json")
+        template 'icon.png', File.join('data', 'templates', pass_type_id, "icon.png")
+        template 'icon@2x.png', File.join('data', 'templates', pass_type_id, "icon@2x.png")
+      end
+    end
+  end
+end