passifier 0.0.2 → 0.0.3

data/README.md

@@ -2,13 +2,13 @@
 
 Generate Apple Passbook passes in Ruby
 
-Passifier does most of the hard work and will easier allow you to automate generating pkpass files. You simply supply
-  
-* A Hash of metadata and layout (basically pass.json for those experienced)
-* Image urls and paths
-* The location of your key/certificate files
-* Output path for the generated .pkpass file
-  
+Passifier does most of the hard work and will more easily allow you to automate generating pkpass files. You simply supply
+
+* A Hash of metadata and layout (the contents of pass.json for those experienced)
+* Image URLs and paths
+* The location of your key and certificate .pem files
+* Output path where you'd like the generated .pkpass file
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -21,43 +21,43 @@ gem 'passifier'
 
 ### Metadata and Layout
 
-First, supply a bunch of pass information and styling.  This will become the file pass.json within the pass archive.  More inforomation on pass.json and creating a layout can be found at [developers.apple.com](https://developer.apple.com/library/prerelease/ios/documentation/UserExperience/Reference/PassKit_Bundle/Chapters/Introduction.html).
+First, supply a bunch of pass information and styling.  This will become the file pass.json within the pass archive.  More information on pass.json and creating a layout can be found at [developers.apple.com](https://developer.apple.com/library/prerelease/ios/documentation/UserExperience/Reference/PassKit_Bundle/Chapters/Introduction.html).
 
 ```ruby
 
 serial = "SO_SERIAL"
 
 spec = {
-  "formatVersion" => 1,
-  "passTypeIdentifier" => "pass.example.example",
-  "teamIdentifier" => "ATEAMID",
-  "relevantDate" => "2012-07-30T14:19Z",          
-  "organizationName" => "Example Inc.",
-  "serialNumber" => serial,
-  "description" => "this is a pass",
-  "labelColor" => "rgb(122, 16, 38)",
-  "backgroundColor" => "rgb(227, 227, 227)",
-  "foregroundColor" => "rgb(110,110,110)",
-  "generic" => {
-    "headerFields" => [
+  "formatVersion": 1,
+  "passTypeIdentifier": "pass.example.example",
+  "teamIdentifier": "METS",
+  "relevantDate": "2012-07-30T14:19Z",          
+  "organizationName": "Example Inc.",
+  "serialNumber": serial,
+  "description": "this is a pass",
+  "labelColor": "rgb(122, 16, 38)",
+  "backgroundColor": "rgb(227, 227, 227)",
+  "foregroundColor": "rgb(110,110,110)",
+  "generic": {
+    "headerFields": [
       {
-        "key" => "date",
-        "label" => "Date",
-        "value" => "October 30th"
+        "key": "date",
+        "label": "Date",
+        "value": "October 30th"
       }
     ],
-    "primaryFields" => [
+    "primaryFields": [
       {
-        "key" => "title",
-        "label" => "",
-        "value" => "Passifier!"
+        "key": "title",
+        "label": "",
+        "value": "Passifier!"
       }
     ],
-    "secondaryFields" => [
+    "secondaryFields": [
       {
-        "key" => "host",
-        "label" => "Host",
-        "value" => "paperlesspost.com",
+        "key": "host",
+        "label": "Host",
+        "value": "paperlesspost.com",
       }
     ]
   }
@@ -66,19 +66,19 @@ spec = {
 
 ### Images
 
-Notice that you can use either paths or urls here
+Specify a Hash of images. Notice that you can use either paths or urls here.
 
 ```ruby
 
-images = {
-  "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 = {
+  "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"
 }
 ```
 
@@ -89,26 +89,34 @@ Give Passifier some info about your .pem files.
 (to-do: more info on obtaining certificates and creating pem files)
 
 ```ruby
-key_pem = "../test/assets/signing/key/key.pem"
+key_pem = "path/to/a/key.pem"
 pass_phrase = "somethingsomething"
-cert_pem = "../test/assets/signing/certificate/certificate.pem"
+cert_pem = "path/to/a/certificate.pem"
+
+# Create a Signing object
+signing = Passifier::Signing.new(key_pem, pass_phrase, cert_pem)
 ```
 
 ### Generate!
 
-```ruby
-# Create the signing
-signing = Passifier::Signing.new(key_pem, pass_phrase, cert_pem)
+Now it's time to create your pass.
 
-# Finally, create the pass archive
-Passifier::Pass.create_archive("readme.pkpass", serial, spec, images, signing)
+```ruby
+Passifier::Pass.generate("readme.pkpass", serial, spec, assets, signing)
 ```
 
 Passifier will have created the file `readme.pkpass` for you.  When opened in Passbook, that pass looks something like:
 
 ![image](http://i.imgur.com/fooaB.jpg)
 
-Find a similar example with some more explanation [here](http://github.com/paperlesspost/passifier/blob/master/examples/simple.rb)
+## Further Reading
+
+* Find a similar example with some more explanation [here](http://github.com/paperlesspost/passifier/blob/master/examples/simple.rb)
+* Read a blog post about Passifier [here]()
+
+## Documentation
+
+* [rubydoc](http://rubydoc.info/github/paperlesspost/passifier)
 
 ## Contributing to Passifier
  

data/examples/simple.rb

@@ -69,19 +69,18 @@ key_pem = "../test/assets/signing/key/key.pem"
 pass_phrase = File.read("../test/assets/signing/pass_phrase.txt").strip.lstrip # you can just replace this with a string if you want
 cert_pem = "../test/assets/signing/certificate/certificate.pem"
 
+# Create a signing object
+signing = Passifier::Signing.new(key_pem, pass_phrase, cert_pem)
+
 #
 #
 # Now, generate the pass!
 #
 #
 
-# Create the signing
-#
-signing = Passifier::Signing.new(key_pem, pass_phrase, cert_pem)
-
 # Create the pass archive
 output_file = "./simple.pkpass"
-Passifier::Pass.create_archive(output_file, serial, spec, images, signing)
+Passifier::Pass.generate(output_file, serial, spec, images, signing)
 
 # Finished!
 puts "Finished generating the pass archive: #{output_file}"

data/lib/passifier.rb

@@ -21,6 +21,6 @@ require "passifier/url_source"
 
 module Passifier
 
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 
 end

data/lib/passifier/manifest.rb

@@ -7,10 +7,10 @@ module Passifier
     attr_reader :hash
     alias_method :to_hash, :hash
 
-    # @param [Array<Passifier::StaticFile, Passifier::UrlSource>] images_files The image files to populate the manifest with
+    # @param [Array<Passifier::StaticFile, Passifier::UrlSource>] asset_files The asset files to populate the manifest with
     # @param [Passifier::Signing] signing The signing to sign the images and generate the digests with
-    def initialize(image_files, signing)
-      @image_files = image_files
+    def initialize(asset_files, signing)
+      @asset_files = asset_files
       populate_content(signing)
     end
 
@@ -28,7 +28,7 @@ module Passifier
     # @return [String] The resulting contents of the manifest file (aka Passifier::Manifest#content)
     def populate_content(signing)
       @hash = {}
-      @image_files.each { |file| @hash[file.name] = signing.sha(file.content) }
+      @asset_files.each { |file| @hash[file.name] = signing.sha(file.content) }
     end
 
   end

data/lib/passifier/pass.rb

@@ -5,7 +5,7 @@ module Passifier
   class Pass
 
     attr_reader :archive, 
-      :image_files, 
+      :asset_files, 
       :manifest, 
       :serial_number, 
       :signature, 
@@ -13,15 +13,15 @@ module Passifier
 
     # @param [String] serial_number An ID for this pass, used as the serial number in pass.json
     # @param [Hash] spec_hash The pass's spec (pass.json)
-    # @param [Hash] images The pass's image assets
+    # @param [Hash] assets The pass's assets (can be local files or remote urls)
     #                      ex. { "background.png" => "https://www.google.com/images/srpr/logo3w.png", 
     #                          "thumbnail.png" => "~/thumb.png" }
     # @param [Signing] signing A valid signing
-    def initialize(serial_number, spec_hash, images, signing, options = {})
+    def initialize(serial_number, spec_hash, assets, signing, options = {})
       @signing = signing
       @spec = Spec.new(serial_number, spec_hash)
-      @image_files = to_image_files(images)
-      @manifest = Manifest.new(@image_files, signing)
+      @asset_files = to_asset_files(assets)
+      @manifest = Manifest.new(@asset_files, signing)
       @signature = ManifestSignature.new(@manifest, signing)
     end
 
@@ -29,7 +29,7 @@ module Passifier
     # @return [Array<Spec, Manifest, ManifestSignature, StaticFile, UrlSource>] File objects that will appear in 
     #                                                                           this pass' archive
     def files_for_archive
-      [@spec, @manifest, @signature, @image_files].flatten.compact
+      [@spec, @manifest, @signature, @asset_files].flatten.compact
     end
 
     # Create the Archive file for this Pass
@@ -54,25 +54,25 @@ module Passifier
     # @param [String] path The desired path of the Archive
     # @param [String] serial_number An ID for this pass, used as the serial number in pass.json
     # @param [Hash] spec_hash The pass's spec (pass.json)
-    # @param [Hash] images The pass's image assets
+    # @param [Hash] assets The pass's assets (can be local files or remote urls)
     #                      ex. { "background.png" => "https://www.google.com/images/srpr/logo3w.png", 
     #                          "thumbnail.png" => "~/thumb.png" }
     # @param [Signing] signing A valid signing
     # @return [Archive] The complete stored archive
-    def self.create_archive(path, serial_number, spec_hash, images, signing, options = {})
-      pass = new(serial_number, spec_hash, images, signing, options)
+    def self.create_archive(path, serial_number, spec_hash, assets, signing, options = {})
+      pass = new(serial_number, spec_hash, assets, signing, options)
       pass.create_archive(path, options)
     end
 
     protected
 
-    # Convert a list of images to Passifier file objects
-    # @param [Hash] images A Hash of filenames and corresponding file paths or urls
+    # Convert a list of assets sources to file objects
+    # @param [Hash] assets A Hash of filenames and corresponding file paths or urls
     # @return [Array<StaticFile, UrlSource>] The resulting StaticFile and/or UrlSource objects
-    def to_image_files(images)
-      images.map do |filename, image| 
-        klass = (image =~ /https?:\/\/[\S]+/) ? UrlSource : StaticFile
-        klass.new(filename, image)
+    def to_asset_files(assets)
+      assets.map do |filename, source| 
+        klass = (source =~ /https?:\/\/[\S]+/) ? UrlSource : StaticFile
+        klass.new(filename, source)
       end.flatten.compact
     end
 

data/test/passifier/test_pass.rb

@@ -4,13 +4,13 @@ class TestPass < Test::Unit::TestCase
 
   include Passifier
 
-  def test_to_image_files
+  def test_to_asset_files
     pass = Helper.new_pass
 
     assert_not_nil pass
-    assert_not_empty pass.image_files
-    assert pass.image_files.all? { |file| [StaticFile, UrlSource].include?(file.class) }
-    assert_equal Helper.new_images.size, pass.image_files.size
+    assert_not_empty pass.asset_files
+    assert pass.asset_files.all? { |file| [StaticFile, UrlSource].include?(file.class) }
+    assert_equal Helper.new_images.size, pass.asset_files.size
   end
 
   def test_files_for_archive

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: passifier
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-13 00:00:00.000000000 Z
+date: 2012-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -156,7 +156,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3690833975389426843
+      hash: 2729969815868987014
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: