passbook-ruby 0.0.6 → 0.1.0

data/README.md

@@ -1,9 +1,14 @@
 # Passbook-Ruby
 
+[![Build Status](https://secure.travis-ci.org/xtremelabs/xl-passbook-ruby.png)](http://travis-ci.org/xtremelabs/xl-passbook-ruby)
+
 [Passbook] is an app distributed on iOS6.
 This is an implementation for management and signing of pkpasses for your Rails application.
 The management of templates and all the other data is done in-memory. This gem does not write to the filesystem. This results in a speed boost.
 
+**Quick Start Video:**<br/>
+http://www.youtube.com/watch?v=GeWFk1FvEKc
+
 ## Usage
 
 ### Install
@@ -51,10 +56,12 @@ I would strongly advise specifying **model_name**, **pass_type_id** and **tead_i
    rails g passbook:pkpass [model_name] [pass_type_id] [team_id] [cert_path] [cert_password]
 ```
 This will generate a model, a migration, an initializer, a route and a sample pass (to data/templates/your_pass_type_id). Make sure to add your
-.p12 into the path now if you use the defaults.
+.p12 into the path now if you use the defaults. Also, if you didn't set the password for the cert in the above command, make sure you change the default to
+your password in config/initializers/passbook_#{model_name}.rb.
 
 
 ```
+   rake db:migrate
    rails s
 ```
 and go to \passes\model_name on your iphone (make sure it is in debug mode and allows http connections)

data/app/controllers/passbook/registrations_controller.rb

@@ -59,6 +59,9 @@ module Passbook
                               :push_token => push_token,
                               :serial_number => params[:serial_number])
 
+          # spawn an event for registration creation
+          pass.register_handler if pass.respond_to? :register_handler
+
           # Return a 201 CREATED status
           # status 201
           render :json => {}, :status => 201
@@ -90,6 +93,10 @@ module Passbook
         registration = Registration.find_by_uuid(uuid)
         unless registration.blank?
           Registration.delete registration.id
+
+          # spawn an event for unregistration event
+          pass.unregister_handler if pass.respond_to? :unregister_handler
+
           render :json => {}, :status => 200
         else
           puts 'Registration does not exist.'

data/app/models/passbook/registration.rb

@@ -17,6 +17,9 @@
 
 
 module Passbook
+  # Model for passbook registrations
+  #
+  # @private
   class Registration < ActiveRecord::Base
     set_table_name "passbook_registrations"
     attr_accessible :device_id, :pass_type_id, :push_token, :serial_number, :uuid

data/lib/passbook-ruby.rb

@@ -21,25 +21,40 @@ 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
+  # @private
   def self.pass_type_id_to_class pass_type_id
     Passbook::Config.instance.pass_config[pass_type_id]['class'].constantize
   end
 
+  # @private
   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
+
+  # Registers a custom renderer for .pkpass files
+  # (executed at load time)
+  #
+  # example:
+  #   render :pkpass ticket
+  #
+  # (where `ticket` is an instance of a model that is configured with passbook-ruby gem)
+  def self.register_pkpass
+    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 if obj.respond_to? :update_pass
+      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
+  end
+  self.register_pkpass
+
 end
 

data/lib/passbook/config.rb

@@ -38,6 +38,7 @@ module Passbook
       read_p12_certificates
     end
 
+    # @private
     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']
@@ -56,6 +57,7 @@ module Passbook
       files
     end
 
+    # @private
     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?
@@ -64,8 +66,9 @@ module Passbook
       end
     end
 
+    # @private
     def read_wwdr_certificate
-      raise(ArgumentError, "Please specify the WWDR Intermediate certificate in your initializer") unless self.wwdr_intermediate_certificate_path
+      # 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
 

data/lib/passbook/engine.rb

@@ -14,9 +14,10 @@
 #  limitations under the License.
 
 
-
-
 module Passbook
+  # This is just a declaration of a Rails engine
+  #
+  # @private
   class Engine < Rails::Engine
   end
 end

data/lib/passbook/pkpass.rb

@@ -23,6 +23,7 @@ require 'zip/zip'
 require 'zip/zipfilesystem'
 
 module Passbook
+  # Pkpass is the class responsible for managing the contect of a pkpass and also signing the package
   class Pkpass
     attr_accessor :files, :translations, :json, :pass_type_id, :serial_number,  :config
 
@@ -48,6 +49,16 @@ module Passbook
       end
     end
 
+    # Add a file to your pkpass
+    #
+    # example:
+    #   pass.add_file "stripe.png", image_content
+    #
+    # == Parameters:
+    # filename::
+    #   A String for the name of the file. It can contain a folder, so it is really a relative path within the pkpass
+    # content::
+    #   Binary content for what will be inside that file
     def add_file filename, content
       self.files[filename] = content
     end
@@ -67,10 +78,12 @@ module Passbook
       self.compress_pass_file
     end
 
+    # @private
     def write_json
       self.files['pass.json'] = JSON.pretty_generate(self.json)
     end
 
+    # @private
     def write_translation_strings
       self.translations.each do |language, trans|
         self.files["#{language}.lproj/pass.strings"] ||= ""
@@ -81,6 +94,7 @@ module Passbook
       end
     end
 
+    # @private
     def generate_json_manifest
       manifest = {}
       self.files.each do |filename, content|
@@ -89,12 +103,14 @@ module Passbook
       self.files['manifest.json'] = JSON.pretty_generate(manifest)
     end
 
+    # @private
     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
 
+    # @private
     def compress_pass_file
       stringio = Zip::ZipOutputStream::write_buffer do |z|
         self.files.each do |filename, content|

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

@@ -15,7 +15,7 @@
 
 
 
-
+# @private
 class CreatePassbookRegistrations < ActiveRecord::Migration
   def change
     create_table :passbook_registrations do |t|

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

@@ -29,7 +29,7 @@ module Passbook
       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}' }"
+        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")

data/spec/config_spec.rb

@@ -19,9 +19,9 @@
 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 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|

data/spec/pkpass_spec.rb

@@ -28,6 +28,7 @@ describe Passbook::Pkpass do
   before :all do
     Passbook::Config.instance.configure do |passbook|
       passbook.wwdr_certificate = OpenSSL::X509::Certificate.new
+      passbook.wwdr_intermediate_certificate_path = "#{Dir.pwd}/spec/data/certificates/wwdr.pem"
     end
 
     Passbook::Config.instance.add_pkpass do |passbook|
@@ -39,7 +40,6 @@ describe Passbook::Pkpass do
                                   "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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: passbook-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-20 00:00:00.000000000 Z
+date: 2012-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -163,3 +163,4 @@ signing_key:
 specification_version: 3
 summary: Passbook pkpass creation and management for Ruby projects
 test_files: []
+has_rdoc: false