troops 0.2.0

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem "betabuilder", ">= 0.4.7.1"
+gem "thor"
+gem "rake"
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jelle Vandebeeck
+
+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

@@ -0,0 +1,108 @@
+# TROOPS
+
+iOS deployment to [TestFlight](http://testflightapp.com) with the [betabuilder](http://rubygems.org/gems/betabuilder) gem.
+
+## Installation
+
+Simply install the gem:
+
+    gem install troops
+
+### Configuration files
+
+There are 2 kind of configuration files, there needs to be a global file & file defined for each project. The files are always named `.troops` and resides in your home folder (for the global file) or in your project folder (for the project dependent file).
+
+### Global file
+
+This `.troops`-file only needs to contain your API Token from TestFlight. You can find this token on the 'Your Account' page. Here is how the file needs to be formatted:
+
+    api_token: "thisismymegaawesometoken"
+
+### Project file
+
+The project's '.troops' file contains the Team Token from your TestFlight Team. and some environmental properties that you can change. The Team Token can be found on the Team Info page.
+
+Next to the token there are some other setting that you can define such as the environment you wish to deploy to (ex. Ad Hoc, Release...), or you can specify the target.
+
+    team_token: "thisismyawesometeamtoken"
+    
+    staging:
+        target: "My App"
+        environment: "Ad Hoc"
+        disitribution_list: ["developers"]
+    
+    production:
+        target: "My App"
+        environment: "Release"
+        disitribution_list: ["developers", "testers"]
+
+Add this file to your project folder.
+
+## Usage
+
+### Archive builds
+
+Archive your application by running the following command:
+    
+    troops archive
+
+This always uses the staging 'environment' to build the correct target. You can specify an environment by adding it as an argument:
+
+    troops archive production
+
+### Deploy to TestFlight
+
+Deploy your application by running the following command:
+    
+    troops deploy
+
+This always uses the **staging** 'environment' to build the correct target. You can specify an environment by adding it as an argument:
+
+    troops deploy production
+
+This command doesn't archive the build, if you want to archive while deploying, add the `--archive` argument.
+
+    troops deploy production --archive
+
+To distribute the build to a disitribution group add the `--distribute` argument. This will send an email to the persons belonging to the distribution list defined in the project `.troops` file.
+
+    troops deploy production --distribute
+
+### Debug
+
+There is also a `--log` argument that helps you debug if there are problems with your build. The betabuilder gem generates some folers & outpur files that are always removed by troops unless you specify the `--logs`argument. 
+
+    * build
+    * build.output
+    * pkg
+
+With the arg these remain inside your project folder.
+
+    troops deploy production --log
+
+When you finished debugging you can just throw away the generated folder & files or run the following command to do it for you:
+
+    troops clean
+    
+## License
+
+Copyright (c) 2011 Jelle Vandebeeck
+
+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/Rakefile

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "troops"
+  gem.homepage = "http://github.com/fousa/troops"
+  gem.license = "MIT"
+  gem.summary = %Q{Deploy your iOS apps to TestFlight with betabuilder}
+  gem.description = %Q{Deploy iOS apps with betabuilder}
+  gem.email = "jelle@fousa.be"
+  gem.authors = ["Jelle Vandebeeck"]
+  gem.executables = ['troops']
+  # dependencies defined in Gemfile
+  gem.add_runtime_dependency 'betabuilder'
+  gem.require_paths = ["lib"]
+  gem.files = [
+    "Rakefile",
+    "Gemfile",
+    "bin/troops",
+    "lib/troops.rb",
+    "lib/troops/configuration.rb",
+  ]
+  gem.version = "0.2.0"
+  gem.extra_rdoc_files = [
+      "README.md", 
+      "LICENSE"
+  ]
+  gem.rdoc_options = ["--main", "README.md"]
+end
+Jeweler::RubygemsDotOrgTasks.new

data/bin/troops

@@ -0,0 +1,40 @@
+#!/usr/bin/ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require "rubygems"
+require "troops"
+require "thor"
+
+module Wasko
+  class CLI < Thor
+    include Thor::Actions
+
+    desc "clean", "Remove the folders & output files generated"
+    def clean
+        Troops.clean
+    end
+
+    desc "archive ENVIRONMENT", "archive the iOS application"
+    method_options :log => :boolean, :alias => :string
+    def archive(environment="staging")
+        Troops.archive({
+            :environment => environment,
+            :log         => options.log? || false
+        })
+    end
+
+    desc "deploy ENVIRONMENT", "deploy the iOS application to testflight"
+    method_options :archive    => :boolean, :alias => :string
+    method_options :distribute => :boolean, :alias => :string
+    method_options :log        => :boolean, :alias => :string
+    def deploy(environment="staging")
+        Troops.deploy({
+            :environment          => environment,
+            :needs_to_archive     => options.archive? || false,
+            :needs_to_disitribute => options.distribute? || false,
+            :log                  => options.log? || false
+        })
+    end
+  end
+end
+Wasko::CLI.start

data/lib/troops.rb

@@ -0,0 +1,136 @@
+require "troops/configuration"
+
+require "rubygems"
+require "betabuilder"
+
+module Troops
+    class << self
+        def clean
+            clear_builds 
+        end
+
+        def archive(args)
+            @environment = args[:environment]
+            @log         = args[:log]
+
+            $stdout.reopen("output.txt", "w") unless @log
+            warn "--- Start archiving"
+
+            configure do 
+                beta_build = build_task 
+
+                archive_build beta_build
+
+                clear_builds unless @log
+            end
+        end
+
+        def deploy(args)
+            @environment         = args[:environment]
+            @needs_to_archive    = args[:needs_to_archive]
+            @needs_to_distribute = args[:needs_to_distribute]
+            @log                 = args[:log]
+
+            $stdout.reopen("output.txt", "w") unless @log
+            warn "--- Start deploying"
+
+            configure do
+                get_release_notes
+                @release_notes = "No release notes specified in troops" if @release_notes.nil? || @release_notes.strip == ""
+
+                beta_build  = build_task 
+                beta_config = archive_build beta_build if @needs_to_archive
+
+                deploy_build_to_testflight beta_build
+
+                clear_builds unless @log
+            end
+        end
+
+        private
+
+        def get_release_notes
+            warn "--- Enter the TestFlight release notes (hit enter 2 times to finish)"
+
+            @release_notes = gets_until_match(/\n{2}$/).strip
+        end
+
+        def gets_until_match(pattern, string = "")
+            if (string += STDIN.gets) =~ pattern
+                string
+            else
+                gets_until_match(pattern, string)
+            end
+        end
+
+        def configure(&block)
+            warn "--- Checking configuration"
+
+            @config = Troops::Configuration.config @environment
+            unless @config.nil?
+                yield
+            end
+        end
+
+        def build_task
+            task = BetaBuilder::Tasks.new do |beta_config|
+                beta_config.xcode4_archive_mode = true
+
+                beta_config.target              = @config[@environment]["target"]
+                beta_config.configuration       = @config[@environment]["configuration"]
+
+                beta_config.deploy_using(:testflight) do |testflight|
+                    testflight.api_token          = @config["api_token"]
+                    testflight.team_token         = @config["team_token"]
+                    testflight.distribution_lists = @config[@environment]["distribution_list"] if @needs_to_distribute && @config[@environment]["distribution_list"]
+                    testflight.generate_release_notes do
+                        @release_notes
+                    end
+                end
+            end
+            beta_build  = task.instance_eval { @configuration }
+
+            build task, beta_build
+
+            beta_build
+        end
+
+        def build(task, beta_build)
+            warn "--- Building the application"
+
+            task.xcodebuild(beta_build.build_arguments, "build")
+        end
+
+        def archive_build(beta_build)
+            beta_archive = BetaBuilder.archive(beta_build)
+            beta_config = beta_archive.instance_eval { @configuration }
+            output_path = beta_archive.save_to(beta_config.archive_path)
+
+            warn "--- Archive saved to #{output_path}."
+
+            beta_config
+        end
+
+        def deploy_build_to_testflight(beta_build)
+            warn "--- Uploading to TestFlight"
+
+            FileUtils.rm_rf('pkg') && FileUtils.mkdir_p('pkg')
+            FileUtils.mkdir_p("pkg/Payload")
+            FileUtils.mv(beta_build.built_app_path, "pkg/Payload/#{beta_build.app_file_name}")
+            Dir.chdir("pkg") do
+                system("zip -r '#{beta_build.ipa_name}' Payload")
+            end
+            FileUtils.mkdir('pkg/dist')
+            FileUtils.mv("pkg/#{beta_build.ipa_name}", "pkg/dist")
+
+            beta_build.deployment_strategy.prepare
+            beta_build.deployment_strategy.deploy
+        end
+
+        def clear_builds
+            warn "--- Clean the output folders & files"
+
+            %w{output.txt pkg build.output build}.each { |f| FileUtils.rm_rf f }
+        end
+    end
+end

data/lib/troops/configuration.rb

@@ -0,0 +1,110 @@
+require "fileutils"
+require 'yaml'
+
+module Troops
+  # This class will handle all things considering
+  # loading and saving configuration. It should work
+  # like this.
+  #
+  # There are 2 kinds of configurations:
+  #  * the project dependent one, has a .troops file with 
+  #    some configuration for the project
+  #  * a user dependent one in the home directory of 
+  #    the user
+  #
+  class Configuration
+    class << self
+        def config(environment)
+            config_hash = yamlize
+            if config_hash["team_token"].nil?
+                puts ""
+                puts "======================================================================================="
+                puts "================================== TROOPS ============================================="
+                puts "======================================================================================="
+                puts "=== You have to set your TestFlight 'team_token' in your ~/.troops file.            ==="
+                puts "=== Here is an example on how the .troop file should look:                          ==="
+                puts "===                                                                                 ==="
+                puts "=== team_token: 'thisisyourawesometeamtoken'                                        ==="
+                puts "===                                                                                 ==="
+                puts "=== You can find your Team Token on your Team Info page on http://testflightapp.com ==="
+                puts "======================================================================================="
+                puts "======================================================================================="
+                puts ""
+            elsif config_hash["api_token"].nil?
+                puts ""
+                puts "============================================================================================="
+                puts "================================== TROOPS ==================================================="
+                puts "============================================================================================="
+                puts "=== You have to set your TestFlight 'api_token' in your .troops file inside this project. ==="
+                puts "=== Here is an example on how the .troops file should look:                               ==="
+                puts "===                                                                                       ==="
+                puts "=== api_token: 'thisisyourawesomeapitoken'                                                ==="
+                puts "=== production:                                                                           ==="
+                puts "===     configuration: 'Release'                                                          ==="
+                puts "===     target: 'The Release iOS App Name'                                                ==="
+                puts "=== staging:                                                                              ==="
+                puts "===     configuration: 'Ad Hoc'                                                           ==="
+                puts "===     target: 'The Ad Hoc iOS App Name'                                                 ==="
+                puts "===                                                                                       ==="
+                puts "=== You can find your Team Token on Your Account page on http://testflightapp.com         ==="
+                puts "============================================================================================="
+                puts "============================================================================================="
+                puts ""
+            elsif config_hash[environment].nil?
+                puts ""
+                puts "============================================================================================="
+                puts "================================== TROOPS ==================================================="
+                puts "============================================================================================="
+                puts "=== You have to set your environment variable in your .troops file.                       ==="
+                puts "=== Here is an example on how the .troops file should look:                               ==="
+                puts "===                                                                                       ==="
+                puts "=== api_token: 'thisisyourawesomeapitoken'                                                ==="
+                puts "=== production:                                                                           ==="
+                puts "===     configuration: 'Release'                                                          ==="
+                puts "===     target: 'The Release iOS App Name'                                                ==="
+                puts "=== staging:                                                                              ==="
+                puts "===     configuration: 'Ad Hoc'                                                           ==="
+                puts "===     target: 'The Ad Hoc iOS App Name'                                                 ==="
+                puts "============================================================================================="
+                puts "============================================================================================="
+                puts ""
+            else
+                config_hash
+            end
+        end
+
+      # Setup the color theme with the hash.
+      def yamlize
+          user_hash = {}
+          user_hash = YAML::load File.open(troops_user_config)
+          user_hash = {} unless Hash === user_hash
+
+          project_hash = {}
+          project_hash = YAML::load File.open(troops_project_config)
+          project_hash = {} unless Hash === project_hash
+
+          project_hash.merge(user_hash)
+      end
+
+      # All user dependent config files are stored in `~/.troops`
+      def troops_user_config
+          configurize "HOME"
+      end
+
+      # All project dependent config files are stored in `.troops`
+      def troops_project_config
+          configurize "PWD"
+      end
+
+      private
+
+      def configurize(env_type="HOME")
+        troops_path = File.join(ENV[env_type], ".troops")
+        unless File.exists?(troops_path) 
+            File.open(troops_path, 'w') 
+        end
+        troops_path
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: troops
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Jelle Vandebeeck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: betabuilder
+  requirement: &70227761277980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70227761277980
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70227761275940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70227761275940
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70227761255900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70227761255900
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70227761245420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70227761245420
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70227761214800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70227761214800
+- !ruby/object:Gem::Dependency
+  name: betabuilder
+  requirement: &70227761206420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70227761206420
+description: Deploy iOS apps with betabuilder
+email: jelle@fousa.be
+executables:
+- troops
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- Gemfile
+- Rakefile
+- bin/troops
+- lib/troops.rb
+- lib/troops/configuration.rb
+- LICENSE
+- README.md
+homepage: http://github.com/fousa/troops
+licenses:
+- MIT
+post_install_message: 
+rdoc_options:
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 913480742456072202
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Deploy your iOS apps to TestFlight with betabuilder
+test_files: []