fruity_builder 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 388eb38a0a12e97f3742704555ca19eaca117ab8
+  data.tar.gz: 39cd6b97094a2b2d2ee8591f7981c25c047b4874
+SHA512:
+  metadata.gz: e7ad3b426b016bd595b0020523a4e93412f80d24376e3627b533b6ba79856594df5a17bdc928bfbe829b7a1c59a74ecaa6a25bcd467867c65aa6b0f1bdf7d92e
+  data.tar.gz: 33eaacaca91a28b4819cf497280e0083df777a86e0fd991c46f6a658e02616fa2870a67e0094a137cdee82cd87f6dd8897f59e21085c18227cd9b92fc68de2f9

data/README.md

@@ -0,0 +1,37 @@
+# Fruity Builder
+
+Code manipulation tools for iOS code bases.
+
+## Usage
+
+Initialise with a path to the project folder:
+
+```ruby
+builder = FruityBuilder::IOS::Helper.new(path)
+```
+
+### Replacing build properties
+
+```ruby
+builder.build.replace_dev_team('New dev team')
+builder.build.replace_code_sign_identity('New identity')
+builder.build.replace_provisioning_profile('New profile')
+builder.build.save_project_properties
+builder.build.replace_bundle_id('New bundle ID')
+```
+
+### Retrieving build properties
+
+```ruby
+builder.build.get_dev_teams # ['Dev Team']
+builder.build.get_code_signing_identities # ['Identity 1', 'Identity 2']
+builder.build.get_provisioning_profiles # ['Profile 1', 'Profile 2']
+```
+
+### Retrieving build configurations
+
+```ruby
+builder.xcode.get_schemes # ['Scheme 1', 'Scheme 2']
+builder.xcode.get_build_configurations # ['Debug', 'Release', 'Test']
+builder.xcode.get_target # ['Target 1', 'Target 2']
+```

data/lib/fruity_builder.rb

@@ -0,0 +1,78 @@
+require 'fruity_builder/lib/sys_log'
+require 'fruity_builder/xcodebuild'
+require 'fruity_builder/build_properties'
+
+
+module FruityBuilder
+  module IOS
+
+    attr_accessor :log
+
+    @@log = FruityBuilder::SysLog.new
+
+    def self.log
+      @@log
+    end
+
+    def self.set_logger(log)
+      @@log = log
+    end
+
+    class Helper
+      attr_accessor :path, :project, :workspace, :build, :plist, :xcode
+
+      def initialize(path)
+        @path = path
+      end
+
+      def project
+        if @project.nil?
+          if @path.scan(/.*xcodeproj$/).count > 0
+            return @path
+          end
+          projects = Dir["#{@path}/**/*.xcodeproj"]
+          projects = projects.select { |project| !project.include?('Pods')}
+          raise HelperCommandError.new('Project not found') if projects.empty?
+          raise HelperCommandError.new('Mulitple projects found, please specify one') if projects.count > 1
+          project = projects.first
+          @project = project
+        end
+        @project
+      end
+
+      def workspace
+        if @workspace.nil?
+          if @path.scan(/.*xcworkspace$/).count > 0
+            return @path
+          end
+          workspace = Dir["#{@path}/**/*.xcworkspace"].first
+          raise 'Workspace not found' if workspace.nil?
+          @workspace = workspace
+        end
+        @workspace
+      end
+
+      # Handle for the BuildProperties class
+      def build
+        if @build.nil?
+          @build = FruityBuilder::IOS::BuildProperties.new("#{project}/project.pbxproj")
+        end
+        @build
+      end
+
+      # Handle for the XCodeBuild class
+      def xcode
+        if @xcode.nil?
+          @xcode = FruityBuilder::IOS::XCodeBuild.new(project)
+        end
+        @xcode
+      end
+    end
+  end
+
+  class HelperCommandError < StandardError
+    def initialize(msg)
+      super(msg)
+    end
+  end
+end

data/lib/fruity_builder/build_properties.rb

@@ -0,0 +1,82 @@
+require 'fruity_builder/lib/execution'
+require 'fruity_builder/plistutil'
+
+module FruityBuilder
+  module IOS
+    class BuildProperties < Execution
+
+      attr_accessor :project, :properties
+
+      def initialize(project_path)
+        @project = project_path
+      end
+
+      def open_project_properties
+        @properties = File.read(@project)
+      end
+
+      def properties
+        open_project_properties if @properties.nil?
+        @properties
+      end
+
+      def save_project_properties
+        File.write(@project, properties)
+      end
+
+      def replace_bundle_id(new_bundle_id)
+        path = Pathname.new(File.dirname(@project) + '/../').realdirpath.to_s
+        xcode = FruityBuilder::IOS::XCodeBuild.new(File.dirname(@project))
+        targets = xcode.get_targets
+        project_files = Dir["#{path}/**/Info.plist"]
+
+        files = project_files.select { |project| targets.any? { |target| project.include?("#{target}/Info.plist") } }
+        files.each do |file|
+          FruityBuilder::IOS::Plistutil.replace_bundle_id(new_id: new_bundle_id, file: file)
+        end
+      end
+
+      def get_dev_teams
+        @properties.scan(/.*DevelopmentTeam = (.*);.*/).uniq.flatten
+      end
+
+      def get_code_signing_identities
+        @properties.scan(/.*CODE_SIGN_IDENTITY.*= "(.*)";.*/).uniq.flatten
+      end
+
+      def get_provisioning_profiles
+        @properties.scan(/.*PROVISIONING_PROFILE = "(.*)";.*/).uniq.flatten
+      end
+
+      def replace_dev_team(new_dev_team)
+        @properties = self.class.replace_project_data(regex: '.*DevelopmentTeam = (.*);.*', data: properties, new_value: new_dev_team)
+      end
+
+      def replace_code_sign_identity(new_identity)
+        @properties = self.class.replace_project_data(regex: '.*CODE_SIGN_IDENTITY.*= "(.*)";.*', data: properties, new_value: new_identity)
+      end
+
+      def replace_provisioning_profile(new_profile)
+        @properties = self.class.replace_project_data(regex: '.*PROVISIONING_PROFILE = "(.*)";.*', data: properties, new_value: new_profile)
+      end
+
+      def self.replace_project_data(options = {})
+        regex = Regexp.new(options[:regex])
+        replacements = options[:data].scan(regex).uniq.flatten
+
+        result = options[:data]
+        replacements.each do |to_replace|
+          result = result.gsub(to_replace, options[:new_value])
+        end
+
+        result
+      end
+    end
+
+    class BuildPropertiesError < StandardError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+  end
+end

data/lib/fruity_builder/lib/execution.rb

@@ -0,0 +1,78 @@
+# Encoding: utf-8
+require 'open3'
+require 'ostruct'
+require 'timeout'
+#require 'fruity_builder'
+
+module FruityBuilder
+  # Provides method to execute terminal commands in a reusable way
+  class Execution
+
+    # execute_with_timeout_and_retry constants
+    COMMAND_TIMEOUT = 30 # base number of seconds to wait until adb command times out
+    COMMAND_RETRIES = 5 # number of times we will retry the adb command.
+    # actual maximum seconds waited before timeout is
+    # (1 * s) + (2 * s) + (3 * s) ... up to (n * s)
+    # where s = COMMAND_TIMEOUT
+    # n = COMMAND_RETRIES
+
+    def self.execute(command)
+      # Execute out to shell
+      # Returns a struct collecting the execution results
+      # struct = DeviceAPI::ADB.execute( 'adb devices' )
+      # struct.stdout #=> "std out"
+      # struct.stderr #=> ''
+      # strict.exit #=> 0
+      result = OpenStruct.new
+
+      stdout, stderr, status = Open3.capture3(command)
+
+      result.exit = status.exitstatus
+      result.stdout = stdout
+      result.stderr = stderr
+
+      result
+    end
+
+    def self.execute_with_timeout_and_retry(command)
+      retries_left = COMMAND_RETRIES
+      cmd_successful = false
+      result = 0
+
+      while (retries_left > 0) and (cmd_successful == false) do
+        begin
+          ::Timeout.timeout(COMMAND_TIMEOUT) do
+            result = execute(command)
+            cmd_successful = true
+          end
+        rescue ::Timeout::Error
+          retries_left -= 1
+          if retries_left > 0
+            FruityBuilder.log.error "Command #{command} timed out after #{COMMAND_TIMEOUT.to_s} sec, retrying,"\
+                + " #{retries_left.to_s} attempts left.."
+          end
+        end
+      end
+
+      if retries_left < COMMAND_RETRIES # if we had to retry
+        if cmd_successful == false
+          msg = "Command #{command} timed out after #{COMMAND_RETRIES.to_s} retries. !"\
+            + " Exiting.."
+          FruityBuilder.log.fatal(msg)
+          raise FruityBuilder::CommandTimeoutError.new(msg)
+        else
+          FruityBuilder.log.info "Command #{command} succeeded execution after retrying"
+        end
+      end
+
+      result
+    end
+  end
+
+  class CommandTimeoutError < StandardError
+    def initialize(msg)
+      super(msg)
+    end
+  end
+
+end

data/lib/fruity_builder/lib/sys_log.rb

@@ -0,0 +1,39 @@
+require 'syslog'
+
+module FruityBuilder
+  class SysLog
+
+    attr_accessor :syslog
+
+    def log(priority,message)
+      if @syslog and @syslog.opened?
+        @syslog = Syslog.reopen('device-api-gem', Syslog::LOG_PID, Syslog::LOG_DAEMON)
+      else
+        @syslog = Syslog.open('device-api-gem', Syslog::LOG_PID, Syslog::LOG_DAEMON)
+      end
+
+      @syslog.log(priority,message)
+      @syslog.close
+    end
+
+    def fatal(message)
+      self.log(Syslog::LOG_CRIT,message)
+    end
+
+    def error(message)
+      self.log(Syslog::LOG_ERR,message)
+    end
+
+    def warn(message)
+      self.log(Syslog::LOG_WARNING,message)
+    end
+
+    def info(message)
+      self.log(Syslog::LOG_INFO,message)
+    end
+
+    def debug(message)
+      self.log(Syslog::LOG_DEBUG,message)
+    end
+  end
+end

data/lib/fruity_builder/plistutil.rb

@@ -0,0 +1,50 @@
+require 'fruity_builder/lib/execution'
+
+module FruityBuilder
+  module IOS
+    class Plistutil < Execution
+
+      def self.get_bundle_id(options = {})
+        if options.key?(:file)
+          xml = IO.read(options[:file])
+        elsif options.key?(:xml)
+          xml = options[:xml]
+        end
+
+        raise PlistutilCommandError.new('No XML was passed') unless xml
+
+        identifiers = xml.scan(/.*CFBundleIdentifier<\/key>\n\t<string>(.*?)<\/string>/)
+        identifiers << xml.scan(/.*CFBundleName<\/key>\n\t<string>(.*?)<\/string>/)
+
+        identifiers.flatten.uniq
+      end
+
+      def self.replace_bundle_id(options = {})
+        if options.key?(:file)
+          xml = IO.read(options[:file])
+        elsif options.key?(:xml)
+          xml = options[:xml]
+        end
+
+        raise PlistutilCommandError.new('No XML was passed') unless xml
+
+        replacements = xml.scan(/.*CFBundleIdentifier<\/key>\n\t<string>(.*?)<\/string>/)
+        replacements << xml.scan(/.*CFBundleName<\/key>\n\t<string>(.*?)<\/string>/)
+
+        replacements.flatten.uniq.each do |replacement|
+          xml = xml.gsub(replacement, options[:new_id])
+        end
+
+        IO.write(options[:file], xml) if options.key?(:file)
+        xml
+      end
+    end
+
+    # plistutil error class
+    class PlistutilCommandError < StandardError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+  end
+end

data/lib/fruity_builder/xcodebuild.rb

@@ -0,0 +1,60 @@
+require 'fruity_builder/lib/execution'
+
+module FruityBuilder
+  module IOS
+    class XCodeBuild < Execution
+
+      attr_accessor :path
+
+      def initialize(path)
+        @path = path
+      end
+
+      def get_schemes
+        self.class.get_schemes(path)
+      end
+
+      def get_targets
+        self.class.get_targets(path)
+      end
+
+      def get_build_configurations
+        self.class.get_build_configurations(path)
+      end
+
+      def self.retrieve_project_section(project_info, section)
+        index = project_info.index(section)
+        section_values = []
+        for i in index+1..project_info.count - 1
+          break if project_info[i].empty?
+          section_values << project_info[i]
+        end
+        section_values
+      end
+
+      def self.get_schemes(project_path)
+        retrieve_project_section(get_project_info(project_path), 'Schemes:')
+      end
+
+      def self.get_build_configurations(project_path)
+        retrieve_project_section(get_project_info(project_path), 'Build Configurations:')
+      end
+
+      def self.get_targets(project_path)
+        retrieve_project_section(get_project_info(project_path), 'Targets:')
+      end
+
+      def self.get_project_info(project_path)
+        info = execute("xcodebuild -project #{project_path} -list")
+        raise XCodeBuildCommandError.new(info.stderr) if info.exit != 0
+        info.stdout.split("\n").map { |a| a.strip }
+      end
+    end
+
+    class XCodeBuildCommandError < StandardError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: fruity_builder
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- BBC
+- Jon Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-20 00:00:00.000000000 Z
+dependencies: []
+description: iOS code signing utilities - used to replace bundle IDs, development
+  teams and provisioning profiles programmatically
+email:
+- jon.wilson01@bbc.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/fruity_builder.rb
+- lib/fruity_builder/build_properties.rb
+- lib/fruity_builder/lib/execution.rb
+- lib/fruity_builder/lib/sys_log.rb
+- lib/fruity_builder/plistutil.rb
+- lib/fruity_builder/xcodebuild.rb
+homepage: https://github.com/bbc/fruity_builder
+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.4.8
+signing_key: 
+specification_version: 4
+summary: iOS code signing utilities
+test_files: []