ruby_build_ios 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d86c0facbac4741b8325a9c178841d29c68ab964
+  data.tar.gz: 4034c6f566de14a9c1a09152418b91c738ef5551
+SHA512:
+  metadata.gz: 3a6442765b90ce2bfb015140cf2027a9f1018c3d4317a8281f949de29bbc7a93161102381283abf4a544d112c1287f7cdb0145a875099c391555791b92f7c4ab
+  data.tar.gz: da154b9855cf4eee3d53f1af59c818e93c7b7b98dfccb8e98d5ba901be9c0ac7fccfaf199f0966c04f0e0aaf54abce80497e30a09df8d3195956a3f10677c12b

data/README.md

@@ -0,0 +1,110 @@
+# README #
+
+ruby_build_ios is a set of helper methods to assist in the development of build scripts for IOS mobile development.
+
+These methods all reside in module RubyBuildIos and were developed as part of HS2's 2017 Hackathon.
+
+## Installation / Usage ##
+
+Install it yourself as:
+
+    $ gem install ruby_build_ios
+
+Then in your build script:
+
+    require 'ruby_build_ios'
+
+## Who do I talk to? ##
+
+HS2 Solutions
+
+https://www.hs2solutions.com
+
+## Documentation ##
+
+Very sparse, but here it is:
+
+    build_project(project, target, configuration, build_number, output_dir)
+
+    build_workspace(workspace, scheme, configuration, build_number, archive_path)
+
+    clean(path)
+
+    copy_provision_file(file_name, uuid)
+
+    create_export_plist(file_name, key_string_pairs)
+
+    get_uuid_from_file(file_name)
+
+    install_provision_file(file_name)
+
+    install_provision_files(file_names_str)
+
+    latest_git_commit_comment(revision = '--all') 
+
+    latest_git_commit_count(revision = '--all')
+
+    project_build_number(file_name = PROJECT_BUILD_NUMBER)
+
+    tag_latest_git_commit(tag, message = 'Sorry, no tag message provided.')
+
+    upload_to_hockey(app_id, api_token, note, file_to_upload)
+
+    upload_to_itunes(user, password, archive)
+
+    xcode_path()
+
+## Testing ##
+
+We're hacking, so our testing is not what it would usually be.  Here are some commands I used in irb to test each function:
+
+Play this to test Module (Class) Functions
+
+    require './lib/ruby_build_ios.rb'
+
+    x=RubyBuildIos.latest_git_commit_count
+
+    x=RubyBuildIos.latest_git_commit_count('badbranch')
+
+
+    require './lib/ruby_build_ios.rb'
+
+    y=RubyBuildIos.latest_git_commit_comment
+
+
+    require './lib/ruby_build_ios.rb'
+
+    RubyBuildIos.tag_latest_git_commit('v1.0', "It is a fine day to commit!")
+
+
+    require './lib/ruby_build_ios.rb'
+
+    z=RubyBuildIos.project_build_number()
+
+
+    TODO: David, add a play here to test copy_provision_files
+
+    require './lib/ruby_build_ios.rb'
+
+    RubyBuildIos.install_provision_files("<file1>,<file2>,<file3>")
+
+
+    TODO: David, add a play script here to test upload_to_hockey
+
+    require './lib/ruby_build_ios.rb'
+
+    RubyBuildIos.upload_to_hockey(app_id, api_token, file_to_upload)
+
+
+    require './lib/ruby_build_ios.rb'
+
+    RubyBuildIos.create_export_plist('test_plist.xml', { 
+      "ca.xxx.iphoneapp" => "XXXXX Prod App",
+      "ca.xxx.iphoneapp.watchkitapp" => "XXXXX Prod WKApp",
+      "ca.xxx.iphoneapp.watchkitapp.extension" => "XXXXX Prod WKExt" })
+
+
+    require './lib/ruby_build_ios.rb'
+
+    RubyBuildIos.xcode_path()
+

data/example.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/ruby
+#
+# example.rb
+
+require './lib/ruby_build_ios.rb'
+
+# This code along with the build_project_workspace fills our current need for
+# setting the build's version number. We have a TODO to allow for greater flexibility
+# in setting build variables
+def get_build_number_string()
+  build_number = RubyBuildIos.latest_git_commit_count()
+  build_number = build_number += 300000000
+  return build_number.to_s
+end
+
+def release_to_qa()
+  archive_path = './build/qa'
+  archive_file = archive_path + '/Example.xcarchive'
+  
+  RubyBuildIos.clean(archive_path)
+  
+  # Copies the provision file to the appropriately named file in ~/Library/MobileDevice/Provisioning Profiles
+  # where Xcode expects to find them.
+  RubyBuildIos.install_provision_file('./certs/EXAMPLE_QA_App.mobileprovision')
+  RubyBuildIos.install_provision_file('./certs/EXAMPLE_QA_WKApp.mobileprovision')
+  RubyBuildIos.install_provision_file('./certs/EXAMPLE_QA_WKExt.mobileprovision')
+  
+  # build_workspace(workspace, scheme, configuration, build_number, archive_path)
+  RubyBuildIos.build_workspace('Example.xcworkspace', 'Example', 'QA', get_build_number_string(), archive_file)
+
+  #upload the app to hockey
+  api_token = '<YOUR HOCKEY API TOKEN>'
+  app_id = "<YOUR HOCKEY APP ID>"
+  hockey_note = RubyBuildIos.latest_git_commit_comment()
+  
+  # upload_to_hockey(app_id, api_token, note, file_to_upload)
+  RubyBuildIos.upload_to_hockey(app_id, api_token, hockey_note, archive_file)
+end
+
+def release_to_prod()
+  archive_path = './build/prod'
+  archive_file = archive_path + '/Example.xcarchive'
+
+
+  RubyBuildIos.clean('./build')
+  
+  # Copies the provision file to the appropriately named file in ~/Library/MobileDevice/Provisioning Profiles
+  # where Xcode expects to find them.
+  RubyBuildIos.install_provision_file('./certs/EXAMPLE_Prod_App.mobileprovision')
+  RubyBuildIos.install_provision_file('./certs/EXAMPLE_Prod_WKApp.mobileprovision')
+  RubyBuildIos.install_provision_file('./certs/EXAMPLE_Prod_WKExt.mobileprovision')
+  
+  # build_workspace(workspace, scheme, configuration, build_number, archive_path)
+  RubyBuildIos.build_workspace('Example.xcworkspace', 'Example', 'Release', get_build_number_string(), archive_file)
+
+  # This builds the plist necessary to create the ipa from the xcarchive
+  # The keys are the bundle ids for the various parts of your app
+  # This particular app has a watch app associated
+  # The values are the Name baked into the provision file. The one you specified when you created the provision profile
+  # You need one entry per profile required for you app. Simple apps need just one. Apps with watch apps need three.
+  plist_file = './build/build.plist'
+  provision_keys = {
+    "com.example.iphoneapp" => "EXAMPLE Prod App",
+    "com.example.iphoneapp.watchkitapp" => "EXAMPLE Prod WKApp",
+    "com.example.iphoneapp.watchkitapp.extension" => "EXAMPLE Prod WKExt" }
+    
+  RubyBuildIos.create_export_plist(plist_file, provision_keys)
+  
+  RubyBuildIos.export_to_ipa(archive_file, plist_file, archive_path)
+  
+  user = '<YOUR ITUNES UPLOAD USER>'
+  password = '<YOUR ITUNES UPLOAD PASS>'
+  
+  RubyBuildIos.validate_with_itunes(user, password, './build/example.ipa')
+end
+
+release_to_qa()

data/lib/ruby_build_ios.rb

@@ -0,0 +1,361 @@
+# ruby-build-ios.rb
+
+module RubyBuildIos
+  require 'open3'
+
+  PROJECT_BUILD_NUMBER = 'PROJECT_BUILD_NUMBER';
+  
+  # https://ruby-doc.org/stdlib-2.0.0/libdoc/open3/rdoc/Open3.html#method-c-capture3
+  # https://ruby-doc.org/core-2.2.0/Process/Status.html
+  # http://ruby-doc.org/core-2.0.0/IO.html#method-i-puts
+
+  def self.latest_git_commit_count(revision = '--all')
+    command = "git rev-list --count #{revision}"
+    print "#{command}\n"
+    # status is a Process::Status 
+    stdout_str, stderr_str, status = Open3.capture3(command)
+    if status.success?
+      print "#{stdout_str}\n"
+    else
+      raise stderr_str;
+    end
+    result = stdout_str.chomp.chomp  
+    result.to_i
+  end
+
+  def self.latest_git_commit_comment(revision = '--all') 
+    command = "git log -1 --oneline #{revision}"
+    print "#{command}\n"
+    # status is a Process::Status 
+    stdout_str, stderr_str, status = Open3.capture3(command)  
+    if status.success?
+      print "#{stdout_str}\n"
+    else
+      raise stderr_str;
+    end
+    result = stdout_str.chomp.chomp  
+  end
+    
+  def self.tag_latest_git_commit(tag, message = 'Sorry, no tag message provided.')
+    command = "git tag -a #{tag} -m \"#{message}\""
+    print "#{command}\n"
+    # status is a Process::Status 
+    # -a is annotate
+    # -m is message
+    # ex: git tag -a v1.4 -m "my version 1.4"
+    stdout_str, stderr_str, status = Open3.capture3(command)
+    if status.success?
+      print "#{stdout_str}\n"
+    else
+      raise stderr_str;
+    end
+    result = stdout_str
+    command = "git push origin #{tag}"
+    print "#{command}\n"
+    # ex: git push origin v1.4
+    stdout_str, stderr_str, status = Open3.capture3(command)
+    if status.success?
+      print "#{stdout_str}\n"
+    else
+      raise stderr_str;
+    end
+
+    result = "#{result}\n#{stdout_str}" 
+  end
+  
+  def self.project_build_number(file_name = PROJECT_BUILD_NUMBER)
+    print "Reading from #{file_name} to get the last project build number\n"
+    file = File.open(file_name, 'r')
+    build_str = file.gets()
+    file.close()
+    
+    build_int = build_str.chomp.to_i
+    
+    build_int += 1
+      
+    build_str = build_int.to_s
+    
+    print "Writing into #{file_name} to set the next project build number\n"
+    file = File.open(file_name, 'w+', 0666)
+    file.puts(build_str)
+    file.close()
+    
+    build_str
+  end  
+  
+  def self.get_uuid_from_file(file_name)
+    command = "/usr/libexec/PlistBuddy -c \"Print UUID\" /dev/stdin <<< $(security cms -D -i #{file_name} 2> /dev/null)"
+    print "#{command}\n"
+    # status is a Process::Status 
+    stdout_str, stderr_str, status = Open3.capture3(command)
+    if status.success?
+      stdout_str = stdout_str.chomp
+      print "#{stdout_str}\n"
+    else
+      raise stderr_str;
+    end
+    result = stdout_str    
+  end
+  
+  def self.copy_provision_file(file_name, uuid)
+    command = "cp #{file_name} ~/Library/MobileDevice/Provisioning\\ Profiles/#{uuid}.mobileprovision"
+    print "#{command}\n"
+    # status is a Process::Status 
+    stdout_str, stderr_str, status = Open3.capture3(command)
+    if status.success?
+      print "#{stdout_str}\n"
+    else
+      raise stderr_str;
+    end
+    result = stdout_str    
+  end
+
+  def self.install_provision_file(file_name)
+    uuid = get_uuid_from_file(file_name)
+    copy_provision_file(file_name, uuid)
+  end
+  
+  def self.install_provision_files(file_names_str)
+    file_names = file_name_str.gsub("\n",'').strip().split(',')
+    file_names.each do |file_name|
+      uuid = get_uuid_from_file(file_name)
+      copy_provision_file(file_name, uuid)
+    end
+  end
+  
+  def self.upload_to_hockey(app_id, api_token, note, file_to_upload)
+    command = "puck -app_id=#{app_id} -api_token=#{api_token} -submit=auto -download=true -notify=true -notes=\"#{note}\" #{file_to_upload}"
+    print "#{command}\n"
+    # status is a Process::Status 
+    stdout_str, stderr_str, status = Open3.capture3(command)
+    if status.success?
+      print "#{stdout_str}\n"
+    else
+      raise stderr_str;
+    end
+    result = stdout_str    
+  end
+  
+  def self.clean(path)
+    if path.chomp == '/'
+      raise "Are you out of your mind?"
+    end
+    command = "rm -fr #{path}/*"
+    print "#{command}\n"
+    # status is a Process::Status 
+    stdout_str, stderr_str, status = Open3.capture3(command)
+    if status.success?
+      print "#{stdout_str}\n"
+    else
+      raise stderr_str;
+    end
+    result = stdout_str    
+  end
+  
+  # TODO allow flexibility in USER DEFINED build variables
+  def self.build_project(project, scheme, configuration, build_number, archive_path)
+    command = "xcodebuild -project #{project} -scheme #{scheme} -configuration #{configuration} -destination 'generic/platform=iOS' PROJECT_BUILD_NUMBER=#{build_number} -archivePath #{archive_path} archive"
+    print "#{command}\n"
+    # status is a Process::Status 
+    result = 'OK'
+    status = nil
+    stderr_str = ''
+    Open3.popen3(command) do |stdin, stdout, stderr, wait|
+
+      t1 = Thread.new do
+        while line = stdout.gets
+          puts line
+        end
+      end
+      
+      t2 = Thread.new do
+        while line = stderr.gets
+          stderr_str << line
+        end
+      end
+      
+      status = wait.value
+      t2.value
+      t1.value
+    end
+      
+    if status.success?
+      print "#{result}\n"
+    else
+      raise stderr_str;
+    end
+    result    
+  end
+
+  # TODO allow flexibility in USER DEFINED build variables  
+  def self.build_workspace(workspace, scheme, configuration, build_number, archive_path)
+    command = "xcodebuild -workspace #{workspace} -scheme #{scheme} -configuration #{configuration} -destination 'generic/platform=iOS' PROJECT_BUILD_NUMBER=#{build_number} -archivePath #{archive_path} archive"
+    print "#{command}\n"
+    # status is a Process::Status 
+    result = 'OK'
+    status = nil
+    stderr_str = ''
+    Open3.popen3(command) do |stdin, stdout, stderr, wait|
+
+      t1 = Thread.new do
+        while line = stdout.gets
+          puts line
+        end
+      end
+      
+      t2 = Thread.new do
+        while line = stderr.gets
+          stderr_str << line
+        end
+      end
+      
+      status = wait.value
+      t2.value
+      t1.value
+    end
+      
+    if status.success?
+      print "#{result}\n"
+    else
+      raise stderr_str;
+    end
+    result    
+  end
+
+  def self.create_export_plist(file_name, key_string_pairs)
+    if !key_string_pairs.is_a? Hash
+      raise "create_export_plist() key_string_pairs must be a Hash\n"
+    end
+    
+    xml_prelude = <<EO1
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>provisioningProfiles</key>
+    <dict>
+EO1
+    xml_postlude = <<EO2
+      </dict>
+    <key>method</key>
+    <string>app-store</string>
+</dict>
+</plist>
+EO2
+    xml_key_string_pairs = ''
+    key_string_pairs.each_pair do |key, string|
+      xml_key_string_pairs << "        <key>#{key}</key>\n"
+      xml_key_string_pairs << "        <string>#{string}</string>\n"
+    end
+
+    print "Writing into #{file_name}\n"
+    file = File.open(file_name, 'w+', 0666)
+    file.puts("#{xml_prelude}#{xml_key_string_pairs}#{xml_postlude}")
+    file.close()
+
+    return true
+  end  
+  
+  def self.xcode_path()
+    command = "dirname \"$(xcode-select -p)\""
+    print "#{command}\n"
+    # status is a Process::Status 
+    stdout_str, stderr_str, status = Open3.capture3(command)
+    if status.success?
+      print "#{stdout_str}\n"
+    else
+      raise stderr_str;
+    end
+    result = stdout_str.chomp.chomp    
+  end
+  
+  def self.export_to_ipa(archive, plist, ipa_path)
+    command = "xcodebuild -exportArchive -exportOptionsPlist #{plist} -archivePath #{archive} -exportPath #{ipa_path}"
+    print "#{command}\n"
+    # status is a Process::Status 
+    stdout_str, stderr_str, status = Open3.capture3(command)
+    if status.success?
+      print "#{stdout_str}\n"
+    else
+      raise stderr_str;
+    end
+    result = stdout_str        
+  end
+  
+  # May want to stream stderr to console too, because altool uses stderr instead of stdout
+  def self.validate_with_itunes(user, password, ipa)
+    # get altools path
+    xcode_path = self.xcode_path
+    altool = "#{xcode_path}/Applications/Application\\ Loader.app/Contents/Frameworks/ITunesSoftwareService.framework/Versions/A/Support/altool"
+    command = "#{altool} --validate-app --type ios -u \"#{user}\" -p \"#{password}\"  -f #{ipa}"
+    print "#{command}\n"
+    result = 'OK'
+    status = nil
+    stderr_str = ''
+    Open3.popen3(command) do |stdin, stdout, stderr, wait|
+
+      t1 = Thread.new do
+        while line = stdout.gets
+          puts line
+        end
+      end
+      
+      t2 = Thread.new do
+        while line = stderr.gets
+          puts line
+          stderr_str << line
+        end
+      end
+      
+      status = wait.value
+      t2.value
+      t1.value
+    end
+      
+    if status.success?
+      print "#{result}\n"
+    else
+      raise stderr_str;
+    end
+    result    
+  end
+
+  # May want to stream stderr to console too, because altool uses stderr instead of stdout
+  def self.upload_to_itunes(user, password, ipa)
+    # get altools path
+    xcode_path = self.xcode_path
+    altool = "#{xcode_path}/Applications/Application\\ Loader.app/Contents/Frameworks/ITunesSoftwareService.framework/Versions/A/Support/altool"
+    command = "#{altool} --upload-app --type ios -u \"#{user}\" -p \"#{password}\"  -f #{ipa}"
+    print "#{command}\n"
+    result = 'OK'
+    status = nil
+    stderr_str = ''
+    Open3.popen3(command) do |stdin, stdout, stderr, wait|
+
+      t1 = Thread.new do
+        while line = stdout.gets
+          puts line
+        end
+      end
+      
+      t2 = Thread.new do
+        while line = stderr.gets
+          puts line
+          stderr_str << line
+        end
+      end
+      
+      status = wait.value
+      t2.value
+      t1.value
+    end
+      
+    if status.success?
+      print "#{result}\n"
+    else
+      raise stderr_str;
+    end
+    result    
+  end
+  
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: ruby_build_ios
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- David Rogers of HS2 Solutions
+- Don Bales of HS2 Solutions
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-15 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby library to help write scripts to build IOS mobile apps written
+  during HS2's 2017 Hackathon. Please use RubyBuildIOS in the subject line when emailing
+  Dave.
+email: david.rogers@hs2solutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- example.rb
+- lib/ruby_build_ios.rb
+homepage: https://rubygems.org/gems/ruby_build_ios
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby Build IOS
+test_files: []