ipa_install_plist_generator 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46b71d4621854f2d4708bd124eb4427808ac953c
-  data.tar.gz: d2d26944ebe0129b1b0892fad985e1ab628e1429
+  metadata.gz: 31edc89e8d250cca4ad93e14b33996ca65cd1e3d
+  data.tar.gz: c325e37535fb8494d4291f53cedea40bbf0e7c72
 SHA512:
-  metadata.gz: 4985fd2480fa12d8d26b0e564482af2b6ccbeed8cc05708dad83769839a3a4e9e0df32b1a4573a2c0acbe44d8f243e26e1510ff4a10ed1f2860b23cc27115cd5
-  data.tar.gz: f61a9531165c62415150f362c1b7af95c457200d4ac3538a634216ced5e2a8f6ab47269ee9a03eac6fe2615444191862cb5b884ef3c59f6289fac2c81afadddd
+  metadata.gz: 17a0c78d5c0d2f48c1173c4e8ba2d399f78a4290d6af324bc73cb0af93a8a139db4fb32e207f12f76d12bce30796cdf30bef7c06bfcb84e35d00bc2b8813ecc5
+  data.tar.gz: 25876f12f4c2ffbd8aa4216074b93a6595303e5a04b1200dcc608f5bf5b33a025c3892a6d228b2a34be03f334edcd67153cd9f00251df9897fb2560c6075dd0b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ipa_install_plist_generator (0.1.0)
+    ipa_install_plist_generator (0.2.0)
       plist (~> 3.1, >= 3.1.0)
 
 GEM

data/README.md

@@ -1,6 +1,83 @@
-# ipa_install_plist_generator
+# IPA install Plist and link generator
 
-Generates a .plist which can be used for an IPA install
+Ruby GEM to generate a .plist which can be used for an IPA install.
 
-**This code will be converted to a Ruby Gem
-once the basic functionality is implemented**
+This GEM can be used in your Ruby project directly or
+you can install it and use it in your Command Line / Terminal.
+
+You can use this GEM as a CLI in two modes:
+
+1. To generate a .plist file which you can save to your server to install an iOS app .ipa. Use the `ipa_plist_gen` command in your Command Line / Terminal.
+2. Once you have an install .plist file and you uploaded it to your server (the URL have to be HTTPS, starting with iOS 8 a normal HTTP URL is not valid for app install!) you can generate an install link by providing the URL of the .plist file. You can then include this link in an email or on your website. A user (who's device is in the Provisioning Profile the .ipa was built with) can then open this special itms link to install the app (.ipa) on an iOS device. Use the `ipa_install_link_gen` command in your Command Line / Terminal.
+
+
+## Generate the install .plist
+
+To generate a .plist file you can call the gem from your Command Line / Terminal:
+
+    $ ipa_plist_gen -i 'https://my-server/ipa-path.ipa' -b 'bundle.id' -t 'App Title'
+
+This will print the .plist file to the standard output, you can redirect it to save it to a file or just copy-paste it into a .plist file.
+
+At the moment a valid install .plist file have to contain the .ipa file's download url, a bundle ID and the app's title. You can define additional information if you want to.
+
+Calling the `ipa_plist_gen` with every parameter looks like this:
+
+    $ ipa_plist_gen -i 'https://my-server/ipa-path.ipa' -b 'bundle.id' -t 'App Title' --bundle-version '1.0.0' --display-image 'disp.img' --full-size-image 'full.img'
+
+And it generated the .plist:
+
+    <?xml version="1.0" encoding="UTF-8"?>
+    <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+    <plist version="1.0">
+    <dict>
+        <key>items</key>
+        <array>
+            <dict>
+                <key>assets</key>
+                <array>
+                    <dict>
+                        <key>kind</key>
+                        <string>software-package</string>
+                        <key>url</key>
+                        <string>https://my-server/ipa-path.ipa</string>
+                    </dict>
+                    <dict>
+                        <key>kind</key>
+                        <string>display-image</string>
+                        <key>needs-shine</key>
+                        <false/>
+                        <key>url</key>
+                        <string>disp.img</string>
+                    </dict>
+                    <dict>
+                        <key>kind</key>
+                        <string>full-size-image</string>
+                        <key>needs-shine</key>
+                        <false/>
+                        <key>url</key>
+                        <string>full.img</string>
+                    </dict>
+                </array>
+                <key>metadata</key>
+                <dict>
+                    <key>bundle-identifier</key>
+                    <string>bundle.id</string>
+                    <key>bundle-version</key>
+                    <string>1.0.0</string>
+                    <key>kind</key>
+                    <string>software</string>
+                    <key>title</key>
+                    <string>App Title</string>
+                </dict>
+            </dict>
+        </array>
+    </dict>
+    </plist>
+
+
+## Generate an install link for the .plist file
+
+Once you uploaded this .plist file to your server you can generate the special `itms-services` link in the Command Line / Terminal:
+
+    $ ipa_install_link_gen -l 'https://my-server/install.plist'

data/bin/ipa_install_link_gen

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+$:.push File.expand_path("../../lib", __FILE__)
+require 'ipa_install_plist_generator'
+
+
+# -------------------------
+# --- Options
+
+options = {
+	install_plist_url: nil,
+	# utils
+	is_verbose: false
+}
+
+opt_parser = OptionParser.new do |opt|
+	opt.banner = "Usage: ipa_install_plist_generator.rb [OPTIONS]"
+	opt.separator  ""
+	opt.separator  "Options, the ones marked with * are required"
+
+	opt.on("-l","--link LINK_URL", "*Plist download URL. It will print an install-url (to the Plist's URL you provide) which can be opened on an iOS device to install the app (itms-services://?action=download-manifest&url=https://path/to/app.plist).") do |value|
+		options[:install_plist_url] = value
+	end
+
+	opt.on("-v","--verbose","Verbose output") do
+		options[:is_verbose] = true
+	end
+
+	opt.on("-h","--help","Shows this help message") do
+		puts opt_parser
+		exit 0
+	end
+end
+
+opt_parser.parse!
+$options = options
+
+
+# -------------------------
+# --- Utils
+
+def vputs(msg="")
+	if $options[:is_verbose]
+		puts msg
+	end
+end
+
+
+# -------------------------
+# --- Main
+
+vputs "options: #{options}"
+
+raise "No .plist URL specified" unless options[:install_plist_url]
+
+inst_url = options[:install_plist_url]
+full_itms_install_url = IpaInstallPlistGenerator::LinkGenerator.new.generate_install_link(inst_url)
+puts full_itms_install_url
+exit 0

data/bin/ipa_plist_gen

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+$:.push File.expand_path("../../lib", __FILE__)
+require 'ipa_install_plist_generator'
+
+
+# -------------------------
+# --- Options
+
+options = {
+	ipa_download_url: nil,
+	bundle_identifier: nil,
+	app_title: nil,
+	bundle_version: nil,
+	display_image: nil,
+	full_size_image: nil,
+	# utils
+	is_verbose: false
+}
+
+opt_parser = OptionParser.new do |opt|
+	opt.banner = "Usage: ipa_install_plist_generator.rb [OPTIONS]"
+	opt.separator  ""
+	opt.separator  "Options, the ones marked with * are required"
+
+	opt.on("-i","--ipa IPA_DOWNLOAD_URL", "*IPA download url") do |value|
+		options[:ipa_download_url] = value
+	end
+
+	opt.on("-b", "--bundle-identifier BUNDLE_ID", "*Metadata: Bundle ID") do |value|
+		options[:bundle_identifier] = value
+	end
+
+	opt.on("-t", "--app-title APP_TITLE", "*Metadata: App Title") do |value|
+		options[:app_title] = value
+	end
+
+	opt.on("--bundle-version BUNDLE_VERSION", "Metadata: Bundle Version") do |value|
+		options[:bundle_version] = value
+	end
+
+	opt.on("--display-image DISPLAY_IMAGE", "Assets: Display Image") do |value|
+		options[:display_image] = value
+	end
+
+	opt.on("--full-size-image FULL_SIZE_IMAGE", "Assets: Full Size Image") do |value|
+		options[:full_size_image] = value
+	end
+
+	opt.on("-v","--verbose","Verbose output") do
+		options[:is_verbose] = true
+	end
+
+	opt.on("-h","--help","Shows this help message") do
+		puts opt_parser
+		exit 0
+	end
+end
+
+opt_parser.parse!
+$options = options
+
+
+# -------------------------
+# --- Utils
+
+def vputs(msg="")
+	if $options[:is_verbose]
+		puts msg
+	end
+end
+
+
+# -------------------------
+# --- Main
+
+vputs "options: #{options}"
+
+
+raise "No IPA download URL specified" unless options[:ipa_download_url]
+raise "No Bundle Identifier specified" unless options[:bundle_identifier]
+raise "No App Title specified" unless options[:app_title]
+
+exit_code = 0
+
+plist_string = IpaInstallPlistGenerator::PlistGenerator.new.generate_plist_string(
+	options[:ipa_download_url],
+	options[:bundle_identifier],
+	options[:app_title],
+	# optional
+	options[:bundle_version],
+	options[:display_image],
+	options[:full_size_image])
+
+puts plist_string
+
+exit exit_code

data/ipa_install_plist_generator.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |s|
 
   s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|log|pkg|script|spec|test|vendor)/ }
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = ['ipa_plist_gen', 'ipa_install_link_gen']
   s.require_paths = ["lib"]
 end

data/lib/ipa_install_plist_generator/install_plist_generator.rb

@@ -2,7 +2,8 @@ require 'plist'
 
 module IpaInstallPlistGenerator
 	class PlistGenerator
-		def generate_plist_string(ipa_download_url, bundle_identifier, app_title, bundle_version=nil)
+		def generate_plist_string(ipa_download_url, bundle_identifier, app_title,
+			bundle_version=nil, display_image=nil, full_size_image=nil)
 
 			raise "No IPA download URL specified" unless ipa_download_url
 			raise "No Bundle Identifier specified" unless bundle_identifier
@@ -25,6 +26,20 @@ module IpaInstallPlistGenerator
 				kind: 'software-package',
 				url: ipa_download_url
 			}
+			if display_image
+				asset_items << {
+					'kind' => 'display-image',
+					'needs-shine' => false,
+					'url' => display_image
+				}
+			end
+			if full_size_image
+				asset_items << {
+					'kind' => 'full-size-image',
+					'needs-shine' => false,
+					'url' => full_size_image
+				}
+			end
 
 			# - create the Plist
 			plist_content_item = {

data/lib/ipa_install_plist_generator/version.rb

@@ -1,3 +1,3 @@
 module IpaInstallPlistGenerator
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ipa_install_plist_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bitrise
@@ -61,7 +61,9 @@ dependencies:
         version: '0'
 description: Generate iOS .ipa (app) install Plist file and link
 email: letsconnect@bitrise.io
-executables: []
+executables:
+- ipa_plist_gen
+- ipa_install_link_gen
 extensions: []
 extra_rdoc_files: []
 files:
@@ -76,6 +78,8 @@ files:
 - "./lib/ipa_install_plist_generator/install_link_generator.rb"
 - "./lib/ipa_install_plist_generator/install_plist_generator.rb"
 - "./lib/ipa_install_plist_generator/version.rb"
+- bin/ipa_install_link_gen
+- bin/ipa_plist_gen
 homepage: 
 licenses:
 - MIT