betabuilder 0.1.2 → 0.2.1

data/CHANGES.md

@@ -0,0 +1,16 @@
+## 0.2.1
+* Allow the namespace of generated tasks to be customised
+
+## 0.2
+* Introduced deployment strategies, allowing custom deployment methods
+* Added support for deploying beta releases to TestFlightApp.com
+
+## 0.1.2
+
+* Allow custom hosts when using the SCP deployment task (simonjefford)
+
+## 0.1.1
+* Fixed missing dependency
+
+## 0.1
+* Initial Release

data/README.md

@@ -33,30 +33,65 @@ Because BetaBuilder is a Rake task library, you do not need to define any tasks
 
       # the Xcode configuration profile
       config.configuration = "Adhoc" 
-      
-      # where the distribution files will be uploaded to
-      config.deploy_to = "http://yourwebsite.com/betas/"
     end
     
 Now, if you run `rake -T` in Terminal.app in the root of your project, the available tasks will be printed with a brief description of each one:
 
     rake beta:build     # Build the beta release of the app
-    rake beta:deploy    # Deploy the beta to your server
     rake beta:package   # Package the beta release as an IPA file
 
-To deploy a beta to your server, some additional configuration is needed (see the next section).
+To deploy your beta to your testers, some additional configuration is needed (see the next section).
 
-Most of the time, you'll not need to run the `beta:build` task directly; it will be run automatically as a dependency of `beta:package`. Upon running this task, your ad-hoc build will be packaged into an IPA file and will be saved in ${PROJECT_ROOT}/pkg/dist, along with a HTML index file and the manifest file needed for over-the-air installation.
+Most of the time, you'll not need to run the `beta:build` task directly; it will be run automatically as a dependency of `beta:package`. Upon running this task, your ad-hoc build will be packaged into an IPA file and will be saved in `${PROJECT_ROOT}/pkg/dist`, along with a HTML index file and the manifest file needed for over-the-air installation.
 
 If you are not using the automatic deployment task, you will need to upload the contents of the pkg/dist directory to your server.
 
-## Automatic deployment
+To use a namespace other than "beta" for the generated tasks, simply pass in your chosen namespace to BetaBuilder::Tasks.new:
 
-BetaBuilder also comes with a (rather rudimentary) automatic deployment task that uses SCP so you will need SSH access to your server and appropriate permissions to use it. You will also need one extra line of configuration in your Rakefile, specifying the path on the remote server where the files will be copied to:
+    BetaBuilder::Tasks.new(:my_custom_namespace) do |config|
+    end
+    
+This lets you set up different sets of BetaBuilder tasks for different configurations in the same Rakefile (e.g. a production and staging build).
+
+## Automatic deployment with deployment strategies
+
+BetaBuilder allows you to deploy your built package using it's extensible deployment strategy system; the gem currently comes with support for simple web-based deployment or uploading to [TestFlightApp.com](http://www.testflightapp.com). Eventually, you will be able to write your own custom deployment strategies if neither of these are suitable for your needs.
+
+### Deploying your app with TestFlight
 
-    config.remote_directory = "/var/www/yourwebsite.com/betas"
+By far the easiest way to get your beta release into the hands of your testers is using the excellent [TestFlight service](http://testflightapp.com/), although at the time of writing it is still in private beta. You can use TestFlight to manage your beta testers and notify them of new releases instantly.
+
+TestFlight provides an upload API and betabuilder uses that to provide a `:testflight` upload strategy. This strategy requires two pieces of information: your TestFlight API token and your team token:
+
+    config.deploy_using(:testflight) do |tf|
+      tf.api_token  = "YOUR_API_TOKEN"
+      tf.team_token = "YOUR_TEAM_TOKEN"
+    end
+    
+Now, instead of using the `beta:package` task, you can run the `beta:deploy` task instead. This task will run the package task as a dependency and upload the generated IPA file to TestFlight. 
+
+You will be prompted to enter the release notes for the build; TestFlight requires these to inform your testers of what has changed in this build. Alternatively, if you have a way of generating the release notes automatically (for instance, using a CHANGELOG file or a git log command), you can specify a block that will be called at runtime - you can do whatever you want in this block, as long as you return a string which will be used as the release notes, e.g.
+
+    config.deploy_using(:testflight) do |tf|
+      ...
+      tf.generate_release_notes do
+        # return release notes here
+      end
+    end
+
+### Deploying to your own server
+
+BetaBuilder also comes with a rather rudimentary web-based deployment task that uses SCP, so you will need SSH access to your server and appropriate permissions to use it. This works in the same way as the original iOS-BetaBuilder GUI app by generating a HTML template and manifest file that can be uploaded to a directly on your server. It includes links to install the app automatically on the device or download the IPA file.
+
+You will to configure betabuilder to use the `web` deployment strategy with some additional configuration:
+
+    config.deploy_using(:web) do |web|
+      web.deploy_to = "http://beta.myserver.co.uk/myapp"
+      web.remote_host = "myserver.com"
+      web.remote_directory = "/remote/path/to/deployment/directory"
+    end
     
-Now, instead of using the `beta:package` task, you can run the `beta:deploy` task instead. This task will run the package task as a dependency and upload the pkg/dist directory to the remote directory you have configured (again, you will need to ensure that you have the correct permissions for this to work).
+The `deploy_to` setting specifies the URL that your app will be published to. The `remote_host` setting is the SSH host that will be used to copy the files to your server using SCP. Finally, the `remote_directory` setting is the path to the location to your server that files will be uploaded to. You will need to configure any virtual hosts on your server to make this work.
 
 ## License
 

data/lib/beta_builder.rb

@@ -3,16 +3,18 @@ require 'ostruct'
 require 'fileutils'
 require 'cfpropertylist'
 require 'beta_builder/archived_build'
+require 'beta_builder/deployment_strategies'
 
 module BetaBuilder
   class Tasks < ::Rake::TaskLib
-    def initialize(&block)
+    def initialize(namespace = :beta, &block)
       @configuration = Configuration.new(
         :configuration => "Adhoc",
         :build_dir => "build",
         :auto_archive => false,
         :archive_path  => File.expand_path("~/Library/MobileDevice/Archived Applications/")
       )
+      @namespace = namespace
       yield @configuration if block_given?
       define
     end
@@ -38,23 +40,28 @@ module BetaBuilder
         "#{built_app_path}.dSYM"
       end
       
-      def deployment_url
-        File.join(deploy_to, target.downcase, ipa_name)
+      def dist_path
+        File.join("pkg/dist")
       end
       
-      def manifest_url
-        File.join(deploy_to, target.downcase, "manifest.plist")
+      def ipa_path
+        File.join(dist_path, ipa_name)
       end
       
-      def remote_installation_path
-        File.join(remote_directory, target.downcase)
+      def deploy_using(strategy_name, &block)
+        if DeploymentStrategies.valid_strategy?(strategy_name.to_sym)
+          self.deployment_strategy = DeploymentStrategies.build(strategy_name, self)
+          self.deployment_strategy.configure(&block)
+        else
+          raise "Unknown deployment strategy '#{strategy_name}'."
+        end
       end
     end
     
     private
     
     def define
-      namespace :beta do
+      namespace(@namespace) do
         desc "Build the beta release of the app"
         task :build => :clean do
           system("xcodebuild #{@configuration.build_arguments} build")
@@ -78,74 +85,20 @@ module BetaBuilder
           end
           FileUtils.mkdir('pkg/dist')
           FileUtils.mv("pkg/#{@configuration.ipa_name}", "pkg/dist")
-          plist = CFPropertyList::List.new(:file => "pkg/Payload/#{@configuration.app_name}/Info.plist")
-          plist_data = CFPropertyList.native_types(plist.value)
-          File.open("pkg/dist/manifest.plist", "w") do |io|
-            io << %{
-              <?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>items</key>
-                <array>
-                  <dict>
-                    <key>assets</key>
-                    <array>
-                      <dict>
-                        <key>kind</key>
-                        <string>software-package</string>
-                        <key>url</key>
-                        <string>#{@configuration.deployment_url}</string>
-                      </dict>
-                    </array>
-                    <key>metadata</key>
-                    <dict>
-                      <key>bundle-identifier</key>
-                      <string>#{plist_data['CFBundleIdentifier']}</string>
-                      <key>bundle-version</key>
-                      <string>#{plist_data['CFBundleVersion']}</string>
-                      <key>kind</key>
-                      <string>software</string>
-                      <key>title</key>
-                      <string>#{plist_data['CFBundleDisplayName']}</string>
-                    </dict>
-                  </dict>
-                </array>
-              </dict>
-              </plist>
-            }
-          end
-          File.open("pkg/dist/index.html", "w") do |io|
-            io << %{
-              <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-              <html xmlns="http://www.w3.org/1999/xhtml">
-              <head>
-              <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-              <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0">
-              <title>Beta Download</title>
-              <style type="text/css">
-              body {background:#fff;margin:0;padding:0;font-family:arial,helvetica,sans-serif;text-align:center;padding:10px;color:#333;font-size:16px;}
-              #container {width:300px;margin:0 auto;}
-              h1 {margin:0;padding:0;font-size:14px;}
-              p {font-size:13px;}
-              .link {background:#ecf5ff;border-top:1px solid #fff;border:1px solid #dfebf8;margin-top:.5em;padding:.3em;}
-              .link a {text-decoration:none;font-size:15px;display:block;color:#069;}
-              </style>
-              </head>
-              <body>
-              <div id="container">
-              <div class="link"><a href="itms-services://?action=download-manifest&url=#{@configuration.manifest_url}">Tap Here to Install<br />#{@configuration.target}<br />On Your Device</a></div>
-              <p><strong>Link didn't work?</strong><br />
-              Make sure you're visiting this page on your device, not your computer.</p>
-              </body>
-              </html>
-            }
-          end
         end
         
-        desc "Deploy the beta to your server"
-        task :deploy => :package do
-          system("scp pkg/dist/* #{@configuration.remote_host}:#{@configuration.remote_installation_path}")
+        if @configuration.deployment_strategy
+          desc "Deploy the beta to your server"
+          task :deploy => :package do
+            @configuration.deployment_strategy.prepare
+            @configuration.deployment_strategy.deploy
+          end
+          
+          desc "Deploy the last build"
+          task :redeploy do
+            @configuration.deployment_strategy.prepare
+            @configuration.deployment_strategy.deploy
+          end
         end
         
         desc "Build and archive the app"

data/lib/beta_builder/deployment_strategies.rb

@@ -0,0 +1,38 @@
+module BetaBuilder
+  module DeploymentStrategies
+    def self.valid_strategy?(strategy_name)
+      strategies.keys.include?(strategy_name.to_sym)
+    end
+
+    def self.build(strategy_name, configuration)
+      strategies[strategy_name.to_sym].new(configuration)
+    end
+
+    class Strategy
+      def initialize(configuration)
+        @configuration = configuration
+
+        if respond_to?(:extended_configuration_for_strategy)
+          @configuration.instance_eval(&extended_configuration_for_strategy)
+        end
+      end
+
+      def configure(&block)
+        yield @configuration
+      end
+
+      def prepare
+      end
+    end
+
+    private
+
+    def self.strategies
+      {:web => Web, :testflight => TestFlight}
+    end
+  end
+end
+
+require 'beta_builder/deployment_strategies/web'
+require 'beta_builder/deployment_strategies/testflight'
+

data/lib/beta_builder/deployment_strategies/testflight.rb

@@ -0,0 +1,60 @@
+require 'rest_client'
+require 'json'
+
+module BetaBuilder
+  module DeploymentStrategies
+    class TestFlight < Strategy
+      ENDPOINT = "http://testflightapp.com/api/builds.json"
+      
+      def extended_configuration_for_strategy
+        proc do
+          def generate_release_notes(&block)
+            self.release_notes = yield if block_given?
+          end
+        end
+      end
+      
+      def deploy
+        payload = {
+          :api_token  => @configuration.api_token,
+          :team_token => @configuration.team_token,
+          :file       => File.new(@configuration.ipa_path, 'rb'),
+          :notes      => get_notes,
+          :notify     => false
+        }
+        puts "Uploading build to TestFlight..."
+        
+        begin
+          response = RestClient.post(ENDPOINT, payload, :accept => :json)
+        rescue => e
+          response = e.response
+        end
+        
+        if response.code == 200
+          puts "Upload complete."
+        else
+          puts "Upload failed. (#{response})"
+        end
+      end
+      
+      private
+      
+      def get_notes
+        @configuration.release_notes || get_notes_using_prompt
+      end
+      
+      def get_notes_using_prompt
+        puts "Enter the release notes for this build (hit enter twice when done):\n"
+        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
+    end
+  end
+end

data/lib/beta_builder/deployment_strategies/web.rb

@@ -0,0 +1,91 @@
+module BetaBuilder
+  module DeploymentStrategies
+    class Web < Strategy
+      def extended_configuration_for_strategy
+        proc do
+          def deployment_url
+            File.join(deploy_to, target.downcase, ipa_name)
+          end
+
+          def manifest_url
+            File.join(deploy_to, target.downcase, "manifest.plist")
+          end
+
+          def remote_installation_path
+            File.join(remote_directory, target.downcase)
+          end
+        end
+      end
+      
+      def prepare
+        plist = CFPropertyList::List.new(:file => "pkg/Payload/#{@configuration.app_name}/Info.plist")
+        plist_data = CFPropertyList.native_types(plist.value)
+        File.open("pkg/dist/manifest.plist", "w") do |io|
+          io << %{
+            <?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>items</key>
+              <array>
+                <dict>
+                  <key>assets</key>
+                  <array>
+                    <dict>
+                      <key>kind</key>
+                      <string>software-package</string>
+                      <key>url</key>
+                      <string>#{@configuration.deployment_url}</string>
+                    </dict>
+                  </array>
+                  <key>metadata</key>
+                  <dict>
+                    <key>bundle-identifier</key>
+                    <string>#{plist_data['CFBundleIdentifier']}</string>
+                    <key>bundle-version</key>
+                    <string>#{plist_data['CFBundleVersion']}</string>
+                    <key>kind</key>
+                    <string>software</string>
+                    <key>title</key>
+                    <string>#{plist_data['CFBundleDisplayName']}</string>
+                  </dict>
+                </dict>
+              </array>
+            </dict>
+            </plist>
+          }
+        end
+        File.open("pkg/dist/index.html", "w") do |io|
+          io << %{
+            <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+            <html xmlns="http://www.w3.org/1999/xhtml">
+            <head>
+            <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+            <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0">
+            <title>Beta Download</title>
+            <style type="text/css">
+            body {background:#fff;margin:0;padding:0;font-family:arial,helvetica,sans-serif;text-align:center;padding:10px;color:#333;font-size:16px;}
+            #container {width:300px;margin:0 auto;}
+            h1 {margin:0;padding:0;font-size:14px;}
+            p {font-size:13px;}
+            .link {background:#ecf5ff;border-top:1px solid #fff;border:1px solid #dfebf8;margin-top:.5em;padding:.3em;}
+            .link a {text-decoration:none;font-size:15px;display:block;color:#069;}
+            </style>
+            </head>
+            <body>
+            <div id="container">
+            <div class="link"><a href="itms-services://?action=download-manifest&url=#{@configuration.manifest_url}">Tap Here to Install<br />#{@configuration.target}<br />On Your Device</a></div>
+            <p><strong>Link didn't work?</strong><br />
+            Make sure you're visiting this page on your device, not your computer.</p>
+            </body>
+            </html>
+          }
+        end
+      end
+      
+      def deploy
+        system("scp pkg/dist/* #{@configuration.remote_host}:#{@configuration.remote_installation_path}")
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: betabuilder
 version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
+  hash: 21
+  prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Luke Redpath
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-05 00:00:00 +00:00
+date: 2011-01-20 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,6 +50,38 @@ dependencies:
         version: 2.3.1
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id004
 description: 
 email: luke@lukeredpath.co.uk
 executables: []
@@ -59,12 +91,16 @@ extensions: []
 extra_rdoc_files: 
 - README.md
 files: 
+- CHANGES.md
 - LICENSE
 - README.md
 - lib/beta_builder/archived_build.rb
+- lib/beta_builder/deployment_strategies/testflight.rb
+- lib/beta_builder/deployment_strategies/web.rb
+- lib/beta_builder/deployment_strategies.rb
 - lib/beta_builder.rb
 - lib/betabuilder.rb
-has_rdoc: false
+has_rdoc: true
 homepage: http://github.com/lukeredpath/betabuilder
 licenses: []
 
@@ -95,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
 summary: A set of Rake tasks and utilities for managing iOS ad-hoc builds