hawk 0.0.1 → 0.1.0

data/LICENSE.txt

@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,29 +1,62 @@
 # Hawk
 
-TODO: Write a gem description
+Hawk is a simple iOS ad-hoc distribution tool. Deployments are lightweight,
+backed by S3 storage (sourced from your own AWS account), and notifications of
+new builds happen via email. Beyond a couple of S3 buckets, the only moving
+parts to hawk are local on your machine. Hawk is a lightweight, low-friction way
+to make ad-hoc deploys easy.
 
-## Installation
+## Status
+
+Hawk is alpha quality software at this point, although I'm rapidly working
+towards firming up a 1.0 release in the next few weeks (by mid Feb 2013). Some
+features that will be coming in the near future include
 
-Add this line to your application's Gemfile:
+### Planned for 0.2
+* Automatic object expiry on S3 for .ipa and plist bundles
+* Support for Xcode workspace files
 
-    gem 'hawk'
+### Planned for 0.3
+* Automatic bucket name selection option
+* Tighter ACL support on uploaded files
 
-And then execute:
+### Planned for 0.4
+* UDID validation
+* Internal refactor
+
+## Installation
 
-    $ bundle
+Install hawk on your machine by either running `gem install hawk`, or else by
+including it in your application's `Gemfile`. Once it's installed run
 
-Or install it yourself as:
+    $ hawkify
 
-    $ gem install hawk
+in your application's top-level directory to create a `Hawkfile` (if one doesn't
+already exist). Open up `Hawkfile` in your editor of choice and follow the
+comments therein to set it up to your liking.
 
 ## Usage
 
-TODO: Write usage instructions here
+Once your `Hawkfile` is customized, you're ready to go. You can create and
+deploy an ad-hoc build of your app by running 
+
+    $ hawk
+
+from any folder inside your application. This will do the following:
+
+1. Build your app for distribution (using the `Release` build configuration)
+2. Sign your app for ad-hoc distribution (according to the `Release` code signing identity in your project)
+3. Upload your app and some associated metadata to S3, using the credentials you
+specify in your `Hawkfile`
+4. Draft an email with a pre-populated body (once again taken from your `Hawkfile`)
+and open it using your local mail application, ready for you to edit and send at
+your leisure
+
+Hawk automatically includes any required provisioning profiles inside the
+deployed app, so users don't need to do anything beyond clicking on the link
+that hawk sends out. There's no client-side app to install, no servers to run,
+no accounts to set up. It just works.
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Contributions welcome! Fork this repo and submit a pull request (or just open up a ticket and I'll see what I can do).

data/bin/hawk

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'hawk'
+
+Hawk::CLI.run(ARGV)

data/bin/hawkify

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'hawk'
+
+Hawk::Hawkifier.new(Dir.pwd).hawkify

data/hawk.gemspec

@@ -18,4 +18,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency('aws-sdk', '~> 1.8')
+  gem.add_dependency('xcodeproj', '~> 0.4')
+  gem.add_dependency('osx-plist', '~> 1.0')
 end

data/lib/hawk/builder.rb

@@ -0,0 +1,82 @@
+require 'tmpdir'
+require 'osx/plist'
+
+module Hawk
+  module Builder
+    module DSL
+      def signing_identity(identity)
+        @signing_identity = identity
+      end
+    end
+
+    def app_name
+      info_plist_property('CFBundleDisplayName')
+    end
+
+    def app_version
+      info_plist_property('CFBundleVersion')
+    end
+
+    def bundle_identifier
+      info_plist_property('CFBundleIdentifier')
+    end
+
+    def repo_version
+      `git rev-parse --short HEAD`.chomp
+    end
+
+    def ipa_file
+      if (!@ipa_file)
+        output_dir = Dir.tmpdir
+        product_name = project_property('PRODUCT_NAME')
+        @ipa_file = File.join(output_dir, "#{product_name}.ipa")
+
+        the_app_file = app_file # Do this before below so output happens in the right order
+
+        print "Signing app..."
+        output = `/usr/bin/xcrun -sdk iphoneos PackageApplication -v -s "#{@signing_identity || "iPhone Distribution"}" -o #{@ipa_file} #{the_app_file} 2>&1`
+        if $?.to_i != 0
+          puts "error (text follows)"
+          abort output
+        end
+        puts "done"
+      end
+      @ipa_file
+    end
+
+    def build_plist
+      ERB.new(File.read(File.join(File.dirname(__FILE__), '..', '..', 'templates', 'manifest.plist.erb'))).result(binding)
+    end
+
+    def itms_url
+      "itms-services://?action=download-manifest&url=#{plist_url}"
+    end
+
+    private
+
+    def app_file
+      if (!@app_file)
+        output_dir = Dir.tmpdir
+
+        print "Building Xcode project..."
+        output = `/usr/bin/xcodebuild CONFIGURATION_BUILD_DIR=#{output_dir} 2>&1`
+        if $?.to_i != 0
+          puts "error (text follows)"
+          abort output
+        end
+        puts "done"
+        @app_file = File.join(output_dir, project_property('FULL_PRODUCT_NAME'))
+      end
+      @app_file
+    end
+
+    def info_plist_property(prop)
+      plist_file = File.join(File.dirname(app_file), project_property('INFOPLIST_PATH'))
+      result = OSX::PropertyList.load_file(plist_file)[prop]
+    end
+
+    def project_property(prop)
+      `/usr/bin/xcodebuild -showBuildSettings | grep "\s#{prop} = "`.gsub!(/.* = /, '').chomp
+    end
+  end
+end

data/lib/hawk/cli.rb

@@ -0,0 +1,25 @@
+module Hawk
+  module CLI
+    def self.run(args)
+      hawkfile = closest_hawkfile(Dir.pwd)
+      if (hawkfile)
+        Dir.chdir(File.dirname(hawkfile))
+        Hawk::DSL.load(hawkfile)
+      else
+        puts "Cannot find hawkfile"
+      end
+    end
+
+    def self.closest_hawkfile(dir)
+      file_name = File.join(dir, 'Hawkfile')
+      if File.exists?(file_name)
+        file_name
+      elsif dir == '/'
+        nil
+      else
+        closest_hawkfile(File.expand_path(File.join(dir, '..')))
+      end
+    end
+  end
+end
+

data/lib/hawk/dsl.rb

@@ -0,0 +1,26 @@
+require 'hawk/builder'
+require 'hawk/s3_uploader'
+require 'hawk/notifier'
+
+module Hawk
+  class DSL
+    include Hawk::Builder::DSL
+    include Hawk::S3Uploader::DSL
+    include Hawk::Notifier::DSL
+
+    def self.load(file)
+      instance = self.new
+      instance.instance_eval(File.read(file), file)
+
+      instance.execute
+    end
+
+    def execute
+      extend Hawk::Builder
+      extend Hawk::S3Uploader
+      extend Hawk::Notifier
+
+      notify_users # notify_users will trigger all dependent actions
+    end
+  end
+end

data/lib/hawk/hawkifier.rb

@@ -0,0 +1,33 @@
+require 'erb'
+
+module Hawk
+  class Hawkifier
+    def initialize(dir)
+      @dir = dir
+    end
+
+    def hawkify
+      files.each do |name, contents|
+        write_file_if_not_exist(name, contents)
+      end
+      puts "hawkify done"
+    end
+
+    private
+    def files
+      { 'Hawkfile' => ERB.new(File.read(File.join(File.dirname(__FILE__), '..', '..', 'templates', 'Hawkfile.erb'))).result }
+    end
+
+    def write_file_if_not_exist(name, contents)
+      file = File.join(@dir, name)
+      if (File.exists?(file))
+        puts "hawkify skipping #{name}; file exists"
+      else
+        File.open(file, 'w') do |f|
+          puts "hawkify writing #{name}"
+          f.write(contents)
+        end
+      end
+    end
+  end
+end

data/lib/hawk/notifier.rb

@@ -0,0 +1,28 @@
+require 'uri'
+
+module Hawk
+  module Notifier
+    module DSL
+      def user(user)
+        puts "Warning: UDID check not implemented yet" if user.is_a? Hash
+        user = { user => nil } unless (user.is_a? Hash)
+        @users ||= {}
+        @users.merge!(user)
+      end
+
+      def email_subject(subject)
+        @email_subject = subject
+      end
+
+      def email_body(body)
+        @email_body = body
+      end
+    end
+
+    def notify_users
+      subject = URI.encode(ERB.new(@email_subject).result(binding)).gsub('?','%3F').gsub('&','%26')
+      body = URI.encode(ERB.new(@email_body).result(binding)).gsub('?','%3F').gsub('&','%26')
+      `open "mailto:?bcc=#{@users.keys.join(',')}&subject=#{subject}&body=#{body}"`
+    end
+  end
+end

data/lib/hawk/s3_uploader.rb

@@ -0,0 +1,54 @@
+require 'aws/s3'
+
+module Hawk
+  module S3Uploader
+    module DSL
+      def access_key_id(key)
+        @access_key_id = key
+      end
+
+      def secret_access_key(key)
+        @secret_access_key = key
+      end
+
+      def bucket_name(name)
+        @bucket_name = name
+      end
+    end
+
+    def ipa_url
+      if (!@ipa_url)
+        file = ipa_file
+        @ipa_url = object(File.basename(file)) do |obj|
+          print "Uploading #{File.basename(file)} to S3..."
+          obj.write(Pathname.new(file))
+          puts 'done'
+        end
+      end
+      @ipa_url
+    end
+
+    def plist_url
+      if (!@plist_url) 
+        @plist_url = object('manifest.plist') do |obj|
+          plist_data = build_plist
+          print 'Uploading plist to S3...'
+          obj.write(plist_data, :content_type => 'application/xml')
+          puts 'done'
+        end
+      end
+      @plist_url
+    end
+
+    private
+
+    def object(name, &block)
+      s3 = AWS::S3.new(:access_key_id => @access_key_id, :secret_access_key => @secret_access_key)
+      bucket = s3.buckets.create @bucket_name
+      obj = bucket.objects[name]
+      yield obj
+      obj.acl = :public_read
+      obj.public_url
+    end
+  end
+end

data/lib/hawk/version.rb

@@ -1,3 +1,3 @@
 module Hawk
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/hawk.rb

@@ -1,5 +1,4 @@
 require "hawk/version"
-
-module Hawk
-  # Your code goes here...
-end
+require "hawk/hawkifier"
+require "hawk/cli"
+require "hawk/dsl"

data/templates/Hawkfile.erb

@@ -0,0 +1,60 @@
+#
+# Hawkfile
+#
+
+#
+# XCode project information - used to configure how your app is built and signed
+#
+# The signing identity to sign your app with. Defaults to 'iPhone Distribution'
+#signing_identity 'iPhone Distribution'
+
+#
+# AWS Credentials - used to upload your app and associated metadata into S3 so
+# that users can download and install your app
+#
+#access_key_id 'AAAAAAAAAAAAAAAAAAAA'
+#secret_access_key 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+#bucket_name 'mah-bukkit'
+
+#
+# User list - a list of users to send emails to upon successsful upload of a new
+# version of your app. Can be specified as simple email addresses, or optionally
+# as a hash with the value being the UDID of their device. Any specified UDIDs
+# will be checked against the built app, to verify that they are entitled to run
+# the app. Any failures will result in a warning being displayed
+#
+#user 'alice@example.com'
+#user 'bob@example.com'
+#user 'claire@example.com' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+
+#
+# Notification settings - parameters describing the email to be sent out. This
+# email will be opened locally on this machine by invoking a 'mailto:' url. Your
+# default mail application will open, allowing you to review and edit the email
+# before sending it. This is usually a good time to describe changes to the app,
+# or to suggest areas for testing and review.
+#
+# The following tags are allowed for replacement. In addition to these tags, any
+# ERB compliant tags will be replaced as well.
+#
+# <%= app_name %>     : The name of the application, taken from the project
+# <%= app_version %>  : The current version of the project, taken from the project's
+#                       Info.plist file
+# <%= repo_version %> : An SCM specific version number taken from the current state
+#                       of the project
+# <%= itms_url %>     : The itms-services: url that users will click on to install
+#                       the application
+#
+
+email_subject "A new update of <%= app_name %> is available for download"
+
+email_body <<EOF
+ A new build of <%= app_name %> is ready to install. Click the followling link
+ on your iOS device to install it:
+
+ <%= itms_url %>
+
+ Please reference '<%= repo_version %>' in any bug reports to help us out.
+
+ Thanks!
+EOF

data/templates/manifest.plist.erb

@@ -0,0 +1,31 @@
+<?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><%= ipa_url %></string>
+                </dict>
+            </array>
+            <key>metadata</key>
+            <dict>
+                <key>bundle-identifier</key>
+                <string><%= bundle_identifier %></string>
+                <key>bundle-version</key>
+                <string><%= app_version %></string>
+                <key>kind</key>
+                <string>software</string>
+                <key>title</key>
+                <string><%= app_name %></string>
+            </dict>
+        </dict>
+    </array>
+</dict>
+</plist>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hawk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-09 00:00:00.000000000 Z
+date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -27,10 +27,44 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: osx-plist
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: A simple iOS ad-hoc distribution tool
 email:
 - mat@geeky.net
-executables: []
+executables:
+- hawk
+- hawkify
 extensions: []
 extra_rdoc_files: []
 files:
@@ -39,9 +73,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/hawk
+- bin/hawkify
 - hawk.gemspec
 - lib/hawk.rb
+- lib/hawk/builder.rb
+- lib/hawk/cli.rb
+- lib/hawk/dsl.rb
+- lib/hawk/hawkifier.rb
+- lib/hawk/notifier.rb
+- lib/hawk/s3_uploader.rb
 - lib/hawk/version.rb
+- templates/Hawkfile.erb
+- templates/manifest.plist.erb
 homepage: http://github.com/mtrudel/hawk
 licenses: []
 post_install_message: