itunes_transporter_generator 0.2 → 0.4.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Colin Humber
+
+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

@@ -1,4 +1,4 @@
-# itunes_transporter_generator
+# itunes_transporter_generator [![Gem Version](https://badge.fury.io/rb/itunes_transporter_generator.png)](http://badge.fury.io/rb/itunes_transporter_generator)
 **CLI for generating and packaging app store assets for Game Center and In-App Purchases**
 
 Apple recently released their Transporter app (http://bit.ly/UcEhAh) which is a handy way to manage your App Store Packages (.itmsp) instead of having to input achievements, leaderboards, and in-app purchases through iTunes Connect. Unfortunately, there isn't an easy way to generate these packages. Why write XML by hand and deal with the hassle of calculating MD5 and file sizes? Why not define your Game Center and In-App Purchases in a simple format and have your App Store Package generated for you?
@@ -10,11 +10,11 @@ $ gem install itunes_transporter_generator
 
 ## Usage
 
-### Get Familiar With The Spec
-First, you'll need to be familiar with the app metadata specification (download from [here](http://bit.ly/TtHMF6)), which outlines all the possible information describing an achievement, leaderboard, or in-app purchase.
+### Get familiar with the spec
+First, you'll need to be familiar with the app metadata specification, available from the bottom navigation in the Manage Your Applications section of iTunes Connect, which outlines all the possible information describing an achievement, leaderboard, or in-app purchase.
 
 ### Describe your application metadata
-Next, you'll need to create a YAML file describing your company information and achievement, leaderboard, and/or in-app purchase details.
+Next, you'll need to create a YAML file describing your company information and achievement, leaderboard, and/or in-app purchase details. The beauty of describing your app store assets in YAML is no hand writing XML making it understandable at a glance, and you can store your configuration in source control.
 
 ### Generate the .itmsp
 This is as simple as running the following command in the folder containing your YAML config file and all referenced images.
@@ -32,54 +32,150 @@ Below is a sample configuration file describing an achievement, leaderboard, and
 ```yaml
 provider: SampleCompany # optional if team_id is supplied
 team_id: ABCDE12345 # optional if provider is supplied
-vendor_id: sample sku # the application's SKU as definied in iTunes Connect 
+vendor_id: sample sku # the application's SKU as defined in iTunes Connect 
 id_prefix: com.samplecompany.applicationname. # if supplied, this will be prefixed to achievement, leaderboard, and in-app purchase IDs
+versions:
+  - name: 1.1.3.1
+    locales:
+      - name: en-US
+        title: sampleApp
+        description: Description of sampleApp.
+        keywords:
+          - Sample
+          - App
+        version_whats_new: Version Whats New.
+        software_url: 'http://example.com'
+        privacy_url: 'http://example.com'
+        support_url: 'http://example.com'
+        screenshots:
+          - display_target: 'iOS-3.5-in'
+            file_name: 'test.jpg'
+
 achievements: # the order in which achievements are defined will be the order in which they appear in Game Center
 - id: first_achievement
   name: First Achievement
   points: 10
   locales:
-      - name: en
-        title: First Achievement
-        before_earned_description: 'Complete a task'
-        after_earned_description: 'Completed a task'
-        after_earned_image: achievement.jpg
-        
+    - name: en
+      title: First Achievement
+      before_earned_description: Complete a task
+      after_earned_description: Completed a task
+      achievement_after_earned_image: test.jpg
+
 leaderboards: # the order in which leaderboards are defined will be the order in which they appear in Game Center
 - default: true # only one leaderboard can be set as default. 
   id: top_scores
   name: Top Scores
   locales:
-      - name: en
-        title: Top Scores
-        formatter_suffix: ' Points' # note the space. This must be provided if you want a space between the value and suffix
-        formatter_suffix_singular: ' Point'
-        formatter_type: INTEGER_COMMA_SEPARATOR
-        leaderboard_image: leaderboard.jpg
-        
+    - name: en
+      title: Top Scores
+      formatter_suffix: ' Points' # note the space. This must be provided if you want a space between the value and suffix
+      formatter_suffix_singular: ' Point'
+      formatter_type: INTEGER_COMMA_SEPARATOR
+      leaderboard_image: test.jpg
+
 purchases:
-- product_id: one_hundred_dollars
-  reference_name: '100 dollars'
-  type: consumable
-  review_screenshot_image: product1.jpg
-  products:
-      - cleared_for_sale: true
-        wholesale_price_tier: 1 # pricing tier matrix is available in Exhibit C of the iOS Paid Applications contract in the Contracts, Tax, and Banking section of iTunes Connect 
-  locales:
-      - name: en
-        title: '$100'
-        description: 'An extra $100 to help you out'
+  auto_renewable_purchases:
+    family:
+      name: Sample Product Group
+      review_screenshot_image: test.jpg
+      purchases:
+        - product_id: six_month_subscription
+          type: auto-renewable  # products in a family group must be of auto-renewable type and be the same product but with different durations
+          duration: 6 Months    # specific values defined in the app metadata specification outline
+          free_trial_duration: 1 Month
+          bonus_duration: 1 Month
+          cleared_for_sale: true
+          wholesale_price_tier: 5
+        - product_id: one_year_subscription
+          type: auto-renewable  # products in a family group must be of auto-renewable type and be the same product but with different durations
+          duration: 1 Year    # specific values defined in the app metadata specification outline
+          bonus_duration: 2 Months
+          cleared_for_sale: true
+          wholesale_price_tier: 9
+      locales:
+        - name: en
+          title: Sample Product Group
+          description: All your products in this sample group
+          publication_name: Sample Product Group
+  other_purchases:
+    - product_id: one_hundred_dollars
+      reference_name: 100 dollars
+      type: consumable
+      review_screenshot_image: test.jpg
+      cleared_for_sale: true
+      wholesale_price_tier: 1 # pricing tier matrix is available in Exhibit C of the iOS Paid Applications contract in the Contracts, Tax, and Banking section of iTunes Connect 
+      locales:
+        - name: en
+          title: $100
+          description: An extra $100 for you
+    - product_id: new_level
+      reference_name: Unlocks a new level
+      type: non-consumable
+      review_screenshot_image: test.jpg
+      cleared_for_sale: true
+      intervals:
+        - start_date: 2013-01-31
+          end_date: 2013-02-28
+          wholesale_price_tier: 3
+        - start_date: 2013-03-01
+          end_date: 2013-05-15
+          wholesale_price_tier: 3
+      locales:
+        - name: en
+          title: Unlocks a new level
+          description: Try your luck at this new level
+    - product_id: another_level
+      reference_name: Unlocks another new level
+      type: non-consumable
+      review_screenshot_image: test.jpg
+      cleared_for_sale: true
+      intervals:
+        - end_date: 2013-08-13
+          wholesale_price_tier: 3
+        - start_date: 2013-08-14
+          wholesale_price_tier: 3
+      locales:
+        - name: en
+          title: Unlocks a new level
+          description: Try your luck at this new level
+
 ```
 
 This configuration will generate the following metadata.xml:
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
-<package xmlns="http://apple.com/itunes/importer" version="software5.0">
+<package xmlns="http://apple.com/itunes/importer" version="software5.1">
   <provider>SampleCompany</provider>
   <team_id>ABCDE12345</team_id>
   <software>
     <vendor_id>sample sku</vendor_id>
     <software_metadata>
+      <versions>
+        <version string="1.1.3.1">
+          <locales>
+            <locale name="en-US">
+              <title>sampleApp</title>
+              <description>Description of sampleApp.</description>
+              <keywords>
+                <keyword>Sample</keyword>
+                <keyword>App</keyword>
+              </keywords>
+              <version_whats_new>Version Whats New.</version_whats_new>
+              <software_url>http://example.com</software_url>
+              <privacy_url>http://example.com</privacy_url>
+              <support_url>http://example.com</support_url>
+              <software_screenshots>
+                <software_screenshot display_target="iOS-3.5-in" position="1">
+                  <file_name>test.jpg</file_name>
+                  <size>20092</size>
+                  <checksum type="md5">ff5bd97a5f40bb75a84884589ecbfc42</checksum>
+                </software_screenshot>
+              </software_screenshots>
+            </locale>
+          </locales>
+        </version>
+      </versions>
       <game_center>
         <achievements>
           <achievement position="1">
@@ -93,18 +189,18 @@ This configuration will generate the following metadata.xml:
                 <title>First Achievement</title>
                 <before_earned_description>Complete a task</before_earned_description>
                 <after_earned_description>Completed a task</after_earned_description>
-                <after_earned_image>
+                <achievement_after_earned_image>
                   <file_name>test.jpg</file_name>
                   <size>20092</size>
                   <checksum type="md5">ff5bd97a5f40bb75a84884589ecbfc42</checksum>
-                </after_earned_image>
+                </achievement_after_earned_image>
               </locale>
             </locales>
           </achievement>
         </achievements>
         <leaderboards>
           <leaderboard default="true" position="1">
-            <leaderboard_id/>
+            <leaderboard_id>com.samplecompany.applicationname.top_scores</leaderboard_id>
             <reference_name>Top Scores</reference_name>
             <sort_ascending>false</sort_ascending>
             <locales>
@@ -122,40 +218,142 @@ This configuration will generate the following metadata.xml:
             </locales>
           </leaderboard>
         </leaderboards>
-        <in_app_purchases>
+      </game_center>
+      <in_app_purchases>
+        <family name="Sample Product Group">
+          <locales>
+            <locale name="en">
+              <title>Sample Product Group</title>
+              <description>All your products in this sample group</description>
+              <publication_name>Sample Product Group</publication_name>
+            </locale>
+          </locales>
+          <review_screenshot>
+            <file_name>test.jpg</file_name>
+            <size>20092</size>
+            <checksum type="md5">ff5bd97a5f40bb75a84884589ecbfc42</checksum>
+          </review_screenshot>
+          <review_notes/>
           <in_app_purchase>
-            <product_id>com.samplecompany.applicationname.one_hundred_dollars</product_id>
-            <reference_name>100 dollars</reference_name>
-            <type>consumable</type>
+            <product_id>com.samplecompany.applicationname.six_month_subscription</product_id>
+            <duration>6 Months</duration>
+            <free_trial_duration>1 Month</free_trial_duration>
+            <bonus_duration>1 Month</bonus_duration>
+            <type>auto-renewable</type>
             <products>
               <product>
                 <cleared_for_sale>true</cleared_for_sale>
-                <wholesale_price_tier>1</wholesale_price_tier>
+                <wholesale_price_tier>5</wholesale_price_tier>
               </product>
             </products>
-            <locales>
-              <locale name="en">
-                <title>$100</title>
-                <description>An extra $100 to help you out</description>
-              </locale>
-            </locales>
-            <review_screenshot>
-              <file_name>test.jpg</file_name>
-              <size>20092</size>
-              <checksum type="md5">ff5bd97a5f40bb75a84884589ecbfc42</checksum>
-            </review_screenshot>
           </in_app_purchase>
-        </in_app_purchases>
-      </game_center>
+          <in_app_purchase>
+            <product_id>com.samplecompany.applicationname.one_year_subscription</product_id>
+            <duration>1 Year</duration>
+            <bonus_duration>2 Months</bonus_duration>
+            <type>auto-renewable</type>
+            <products>
+              <product>
+                <cleared_for_sale>true</cleared_for_sale>
+                <wholesale_price_tier>9</wholesale_price_tier>
+              </product>
+            </products>
+          </in_app_purchase>
+        </family>
+        <in_app_purchase>
+          <product_id>com.samplecompany.applicationname.one_hundred_dollars</product_id>
+          <reference_name>100 dollars</reference_name>
+          <type>consumable</type>
+          <products>
+            <product>
+              <cleared_for_sale>true</cleared_for_sale>
+              <wholesale_price_tier>1</wholesale_price_tier>
+            </product>
+          </products>
+          <locales>
+            <locale name="en">
+              <title>$100</title>
+              <description>An extra $100 for you</description>
+            </locale>
+          </locales>
+          <review_screenshot>
+            <file_name>test.jpg</file_name>
+            <size>20092</size>
+            <checksum type="md5">ff5bd97a5f40bb75a84884589ecbfc42</checksum>
+          </review_screenshot>
+        </in_app_purchase>
+        <in_app_purchase>
+          <product_id>com.samplecompany.applicationname.new_level</product_id>
+          <reference_name>Unlocks a new level</reference_name>
+          <type>non-consumable</type>
+          <products>
+            <product>
+              <cleared_for_sale>true</cleared_for_sale>
+              <intervals>
+                <interval>
+                  <start_date>2013-01-31</start_date>
+                  <end_date>2013-02-28</end_date>
+                  <wholesale_price_tier>3</wholesale_price_tier>
+                </interval>
+              </intervals>
+            </product>
+          </products>
+          <locales>
+            <locale name="en">
+              <title>Unlocks a new level</title>
+              <description>Try your luck at this new level</description>
+            </locale>
+          </locales>
+          <review_screenshot>
+            <file_name>test.jpg</file_name>
+            <size>20092</size>
+            <checksum type="md5">ff5bd97a5f40bb75a84884589ecbfc42</checksum>
+          </review_screenshot>
+        </in_app_purchase>
+        <in_app_purchase>
+          <product_id>com.samplecompany.applicationname.another_level</product_id>
+          <reference_name>Unlocks another new level</reference_name>
+          <type>non-consumable</type>
+          <products>
+            <product>
+              <cleared_for_sale>true</cleared_for_sale>
+              <intervals>
+                <interval>
+                  <end_date>2013-02-28</end_date>
+                  <wholesale_price_tier>3</wholesale_price_tier>
+                </interval>
+                <interval>
+                  <start_date>2013-08-14</start_date>
+                  <wholesale_price_tier>3</wholesale_price_tier>
+                </interval>
+              </intervals>
+            </product>
+          </products>
+          <locales>
+            <locale name="en">
+              <title>Unlocks a new level</title>
+              <description>Try your luck at this new level</description>
+            </locale>
+          </locales>
+          <review_screenshot>
+            <file_name>test.jpg</file_name>
+            <size>20092</size>
+            <checksum type="md5">ff5bd97a5f40bb75a84884589ecbfc42</checksum>
+          </review_screenshot>
+        </in_app_purchase>
+      </in_app_purchases>
     </software_metadata>
   </software>
 </package>
+
 ```
 
 ## Todo
 * TESTS. High on my list
+* RDocs. Definitely need to document this.
 * Metadata validation. There are lots of rules depending on what values you provide. You should know when you generate the package if there are any issues instead of having Apple tell you when you upload
 * Anything else! Pull requests are welcome! This is my first Ruby project so I'm sure there is are a lot of improvements that can be made
+* <s>Finish in-app purchase XML generation (lots of different options here!)</s>
 
 ## Contact
 
@@ -166,4 +364,4 @@ Colin Humber
 
 ## License
 
-itmsp is available under the MIT license. See the LICENSE file for more info.
+itmsp is available under the MIT license. See the LICENSE file for more info.

data/doc/Itunes.html

@@ -0,0 +1,198 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+
+  <title>Module: Itunes</title>
+
+  <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
+
+  <script src="./js/jquery.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/darkfish.js" type="text/javascript" charset="utf-8"></script>
+
+</head>
+<body id="top" class="module">
+
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="./index.html">Home</a>
+          <a href="./index.html#classes">Classes</a>
+          <a href="./index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+          
+            <li><a href="./lib/itunes/transporter/achievement_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/itunes/transporter/achievement.rb">lib/itunes/transporter/achievement.rb</a></li>
+          
+            <li><a href="./lib/itunes/transporter/generator_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/itunes/transporter/generator.rb">lib/itunes/transporter/generator.rb</a></li>
+          
+            <li><a href="./lib/itunes/transporter/helpers_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/itunes/transporter/helpers.rb">lib/itunes/transporter/helpers.rb</a></li>
+          
+            <li><a href="./lib/itunes/transporter/in_app_purchase_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/itunes/transporter/in_app_purchase.rb">lib/itunes/transporter/in_app_purchase.rb</a></li>
+          
+            <li><a href="./lib/itunes/transporter/leaderboard_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/itunes/transporter/leaderboard.rb">lib/itunes/transporter/leaderboard.rb</a></li>
+          
+            <li><a href="./lib/itunes/transporter/locale_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/itunes/transporter/locale.rb">lib/itunes/transporter/locale.rb</a></li>
+          
+            <li><a href="./lib/itunes_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/itunes.rb">lib/itunes.rb</a></li>
+          
+          </ul>
+        </div>
+      </div>
+
+      
+    </div>
+
+    <div id="class-metadata">
+      
+
+      
+
+      
+      <!-- Namespace Contents -->
+      <div id="namespace-list-section" class="section">
+        <h3 class="section-header">Namespace</h3>
+        <ul class="link-list">
+          
+          <li><span class="type">MODULE</span> <a href="Itunes/Transporter.html">Itunes::Transporter</a></li>
+          
+        </ul>
+      </div>
+      
+
+      
+
+      
+    </div>
+
+    <div id="project-metadata">
+      
+      
+      <div id="fileindex-section" class="section project-section">
+        <h3 class="section-header">Files</h3>
+        <ul>
+        
+          <li class="file"><a href="./Rakefile.html">Rakefile</a></li>
+        
+        </ul>
+      </div>
+      
+
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="./images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+
+        <ul class="link-list">
+        
+          <li><a href="./Itunes.html">Itunes</a></li>
+        
+          <li><a href="./Itunes/Transporter.html">Itunes::Transporter</a></li>
+        
+          <li><a href="./Itunes/Transporter/Achievement.html">Itunes::Transporter::Achievement</a></li>
+        
+          <li><a href="./Itunes/Transporter/AchievementLocale.html">Itunes::Transporter::AchievementLocale</a></li>
+        
+          <li><a href="./Itunes/Transporter/Generator.html">Itunes::Transporter::Generator</a></li>
+        
+          <li><a href="./Itunes/Transporter/Helpers.html">Itunes::Transporter::Helpers</a></li>
+        
+          <li><a href="./Itunes/Transporter/InAppPurchase.html">Itunes::Transporter::InAppPurchase</a></li>
+        
+          <li><a href="./Itunes/Transporter/Interval.html">Itunes::Transporter::Interval</a></li>
+        
+          <li><a href="./Itunes/Transporter/Leaderboard.html">Itunes::Transporter::Leaderboard</a></li>
+        
+          <li><a href="./Itunes/Transporter/LeaderboardLocale.html">Itunes::Transporter::LeaderboardLocale</a></li>
+        
+          <li><a href="./Itunes/Transporter/Locale.html">Itunes::Transporter::Locale</a></li>
+        
+          <li><a href="./Itunes/Transporter/Product.html">Itunes::Transporter::Product</a></li>
+        
+          <li><a href="./Itunes/Transporter/PurchaseLocale.html">Itunes::Transporter::PurchaseLocale</a></li>
+        
+          <li><a href="./Object.html">Object</a></li>
+        
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+
+      
+    </div>
+  </div>
+
+  <div id="documentation">
+    <h1 class="module">Itunes</h1>
+
+    <div id="description" class="description">
+      
+    </div><!-- description -->
+
+    
+    
+    
+    <div id="5Buntitled-5D" class="documentation-section">
+      
+
+      
+
+      
+      <!-- Constants -->
+      <div id="constants-list" class="section">
+        <h3 class="section-header">Constants</h3>
+        <dl>
+        
+          <dt><a name="VERSION">VERSION</a></dt>
+          
+          <dd class="description"></dd>
+          
+        
+        </dl>
+      </div>
+      
+
+      
+
+      <!-- Methods -->
+      
+    </div><!-- 5Buntitled-5D -->
+  
+
+  </div><!-- documentation -->
+
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+
+</body>
+</html>
+