tug 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e1f066ca1ec2ee9e8bd50c118e4c886e6f40936
-  data.tar.gz: 3e3c7568b877698ef35f68f3d9611917af5b2d4a
+  metadata.gz: 92525ca816fadaf365802e1ef27f74e35e725a0c
+  data.tar.gz: 76d77bbbe3c1a3ff2efe8516ac24a1ab6ad3d740
 SHA512:
-  metadata.gz: 5a64c83652aebcb0292843ec17e68c6f52682e55e6a81d5d9953ffd2fd4dddef9201b1442c61c632a061a7f637ff820e97177176e1ec38aea688976f1ce51a18
-  data.tar.gz: 730887b46c17cdd92250cbd769862879dc64ec5e3c6d2596e38cef986156522baeb38e64da963876771fc76e82fd9efa37d903c398667bbaaf877b51ebcb8131
+  metadata.gz: 621ec288ab99b7cba06746a73368e6e191a82891a78efd79eda15a7a4b70a06f29ec1af2e4282ed101db629492701b727345468371bc3a11c00849abf45e146b
+  data.tar.gz: d4774587818baf97de2c7b185d429081b6b7e33e30374132be5203f46307d365ce4ee703a74b246f46e8985888f59bf24cc41af861d19cd63002602632974354

data/README.md

@@ -21,17 +21,7 @@ Or install it yourself as:
 
     $ gem install tug
 
-## Usage
-
-### Build
-
-Run `tug build` from your Xcode projects root directory. Each scheme in the scheme config array will be built.
-
-### IPA
-
-Run `tug ipa` from your Xcode projects root directory, see the example config below for details on how to set a configuration and profile name. An ipa will be generated for each scheme in the config's scheme array.
-
-### Config
+## Config
 
 tug will look in the current directory for a `.tug.yml` config file by default, use the `--config` option to pass a path to your config file if it's in a different folder. 
 
@@ -45,7 +35,85 @@ project:
   ipa_config: Release            # The configuration to use to build ipas
 ```
 
-### Provisioning
+
+## Commands
+
+### Build
+
+Build from your Xcode projects root directory. Each scheme in the scheme config array will be built.
+
+```
+$ tug build
+```
+
+##### Options
+
+```
+-c, [--config=CONFIG]     # the tug config file to use (optional, defaults to .tug.yml)
+```
+
+### IPA
+
+Generate an ipa from your Xcode projects root directory, see the example config below for details on how to set a configuration and profile name. An ipa will be generated for each scheme in the config's scheme array.
+
+```
+$ tug ipa
+```
+
+##### Options
+
+```
+-c, [--config=CONFIG]     # the tug config file to use (optional, defaults to .tug.yml)
+-e, [--export=EXPORT]     # the directory to export the .ipa to (optional, defaults to current directory)
+```
+
+### Deploy
+
+Distrubute your builds to external services using the `deploy` command
+
+#### Testflight
+
+```
+$ tug ipa
+$ tug deploy testflight
+```
+
+
+###### Options
+
+```
+-f, [--file=FILE]               # path to an ipa to deploy (optional, searches current directory by default)
+-a, [--api-token=API_TOKEN]     # testflight api token (optional, environmental variable by default)
+-t, [--team-token=TEAM_TOKEN]   # testflight tea, token (optional, environmental variable by default)
+-l, [--lists=LISTS]             # testflight distrubution lists to send the buld to (optional, defaults to none)
+-n, [--notify=NOTIFY]           # notify testflight users of the new build (optional, defaults to false)
+```
+
+> 
+> The following environment variables are used to set your testflight API and team tokens
+> * `TUG_TESTFLIGHT_API_KEY`
+> * `TUG_TESTFLIGHT_TEAM_KEY`
+
+### Provision
+
+Tug can provision a new machine ready for signing ipas by installing the certificates and provisioning profile required for generating a signed ipa of your application, this is very useful for CI environments like Travis. 
+
+```
+$ tug provision
+```
+
+##### Options
+
+```
+-c, [--config=CONFIG]           # the tug config file to use (optional, defaults to .tug.yml)
+-k, [--keychain=KEYCHAIN]       # the keychain to install the certificates to (optional, defaults to tug)
+-p, [--password=PASSWORD]       # the password required to access your .p12 private key (optional, environment variable by default)
+```
+
+> The following environment variable is used to set your .p12 private key password
+> * `TUG_P12_PASSWORD`
+
+#### Config 
 
 Provisioning requires you to export the following files from your keychain and place them within your project directory:
 
@@ -54,7 +122,7 @@ Provisioning requires you to export the following files from your keychain and p
 * iPhone Distribution Private Key
 * Distribution Provisioning Profile
 
-Run `tug provision` to provision a new machine ready for signing ipas, provisioning requires a `keychain` object in the config yaml file to specify the path to the provisioning certificates and profile:
+Provisioning also requires a `keychain` object in the config yaml file to specify the path to the exported provisioning certificates and profile:
 
 ```
 keychain:
@@ -64,15 +132,6 @@ keychain:
   private_key: certs/dist.p12
 ```
 
-#### Private Key Password
-
-If your `.p12` private key requires a password, you can either set the environment variable:
-
-`$ export TUG_P12_PASSWORD=yourpassword`
-
-or use the `--password` option when running the provision command:
-
-`$ tug provision --password yourpassword`
 
 ## Contributing
 

data/lib/tug/command/command.rb

@@ -10,6 +10,8 @@ module Tug
           Tug::IpaCommand.new
         when "provision"
           Tug::ProvisionCommand.new
+        when "deploy"
+          Tug::DeployCommand.new
         else
           Tug::Command.new
         end

data/lib/tug/deployment/deployer.rb

@@ -0,0 +1,49 @@
+module Tug
+  class Deployer
+
+    attr_reader :ipa
+    attr_reader :api_token
+    attr_reader :team_token
+    attr_reader :lists
+    attr_reader :notify
+
+    class << self
+      def deployer(options)
+        Tug::Deployer.new(options)
+      end
+    end
+
+    def initialize(options)
+      @ipa        = options[:file]
+      @lists      = options[:lists]
+      @notify     = options[:notify]
+      @api_token  = options[:api_token]
+      @team_token = options[:team_token]
+    end
+
+    def deploy
+      IO.popen("curl #{url} -X POST -# #{params}") do |pipe|
+        puts pipe.read
+      end
+    end
+
+    private
+
+    def url
+      "http://testflightapp.com/api/builds.json"
+    end
+
+    def notes
+      "This build was uploaded via Tug"
+    end
+
+    def params
+      params = "-F file=@#{ipa} "
+      params += "-F api_token='#{api_token}' "
+      params += "-F team_token='#{team_token}' "
+      params += "-F notes='#{notes}' "
+      params += "-F distribution_lists='#{lists}' "
+      params += "-F notify=#{notify}"
+    end
+  end
+end

data/lib/tug/interface/interface.rb

@@ -1,4 +1,26 @@
 module Tug
+
+  class Deploy < Thor
+
+    desc "testflight", "deploy an ipa to testflight"
+    option :file, :aliases => "-f", :default => Dir.glob("*.ipa").first
+    option :api_token, :aliases => "-a", :default => ENV['TUG_TESTFLIGHT_API_TOKEN']
+    option :team_token, :aliases => "-t", :default => ENV['TUG_TESTFLIGHT_TEAM_TOKEN']
+    option :lists, :aliases => "-l"
+    option :notify, :aliases => "-n", :default => false
+    def testflight
+      deployer = Tug::Deployer.deployer(options)
+      deployer.deploy
+    end
+
+    no_commands do
+      def execute(config_file)
+        command = Tug::Command.command_for_string("deploy")
+        command.execute(config_file)
+      end
+    end
+  end
+
   class Interface < Thor
 
     desc "build", "build a project"
@@ -20,7 +42,7 @@ module Tug
     desc "provision", "provision system distrubution certificates and provisioning profile"
     option :config, :default => "#{Dir.pwd}/.tug.yml", :aliases => "-c"
     option :keychain, :default => "tug", :aliases => "-k"
-    option :password, :aliases => "-p"
+    option :password, :aliases => "-p", :default => ENV['TUG_P12_PASSWORD']
     def provision
       config_file = Tug::ConfigFile.config_file(options[:config])
       config_file.keychain.name = options[:keychain]
@@ -28,6 +50,9 @@ module Tug
       execute(__method__.to_s, config_file)
     end
 
+    desc "deploy", "deploy an ipa to an external service"
+    subcommand "deploy", Deploy
+
     no_commands do
       def execute(command, config_file)
         command = Tug::Command.command_for_string(command)

data/lib/tug/keychain/keychain.rb

@@ -21,6 +21,8 @@ module Tug
       @distribution_certificate   = keychain_yaml["distribution_certificate"]
       @distribution_profile       = keychain_yaml["distribution_profile"]
       @private_key                = keychain_yaml["private_key"]
+
+      # these defaults are also set in Interface
       @private_key_password       = ENV['TUG_P12_PASSWORD']
       @name                       = "tug"
     end

data/lib/tug/tool/xctool.rb

@@ -6,7 +6,7 @@ module Tug
     class << self
       def tool_for_config(config)
         case config.downcase
-        when "inhouse", "release"
+        when "inhouse", "release", /release/, /inhouse/
           Tug::XCToolArchive.new(config)
         else
           Tug::XCToolBuild.new(config)

data/lib/tug/version.rb

@@ -1,3 +1,3 @@
 module Tug
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/tug.rb

@@ -21,4 +21,6 @@ require "tug/tool/xctool"
 require "tug/tool/xctool_build"
 require "tug/tool/xctool_archive"
 
-require "tug/keychain/keychain"
+require "tug/keychain/keychain"
+
+require "tug/deployment/deployer"

data/spec/deployer_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Tug::Deployer do
+
+  before(:each) do
+    @options = {
+      :api_token => "api_token",
+      :team_token => "team_token",
+      :file => "test.ipa",
+      :notify => true
+    }
+
+    @deployer = Tug::Deployer.deployer(@options)
+  end
+
+  describe "when returning a deployer" do
+    it "should return a default deployer" do
+      expect(Tug::Deployer.deployer(@options)).to be_kind_of(Tug::Deployer)
+    end
+  end
+
+  describe "when deploying" do
+
+    it "should send to testflight by default" do
+      expect(IO).to receive(:popen).with(/http:\/\/testflightapp.com\/api\/builds.json/)
+      @deployer.deploy
+    end
+
+    it "should send the ipa as a param" do
+      expect(IO).to receive(:popen).with(/-F file=@test.ipa/)
+      @deployer.deploy
+    end
+
+    it "should send the team token as a param" do
+      expect(IO).to receive(:popen).with(/-F team_token='team_token'/)
+      @deployer.deploy
+    end
+
+    it "should send the api token as a param" do
+      expect(IO).to receive(:popen).with(/-F api_token='api_token'/)
+      @deployer.deploy
+    end
+
+    it "should have some release notes" do
+      expect(IO).to receive(:popen).with(/-F notes='This build was uploaded via Tug'/)
+      @deployer.deploy
+    end
+
+    it "should have lists" do
+      expect(IO).to receive(:popen).with(/-F distribution_lists=''/)
+      @deployer.deploy
+    end
+
+    it "should notify" do
+      expect(IO).to receive(:popen).with(/-F notify=true/)
+      @deployer.deploy
+    end
+  end
+end

data/spec/xctool_spec.rb

@@ -11,5 +11,15 @@ describe Tug::XCTool do
       xctool = Tug::XCTool.tool_for_config("InHouse")
       expect(xctool).to be_kind_of(Tug::XCToolArchive)
     end
+
+    it "should return an archive tool when release is in the config" do
+      xctool = Tug::XCTool.tool_for_config("TestRelease")
+      expect(xctool).to be_kind_of(Tug::XCToolArchive)
+    end
+
+    it "should return an archive tool when inhouse is in the config" do
+      xctool = Tug::XCTool.tool_for_config("TestInHouse")
+      expect(xctool).to be_kind_of(Tug::XCToolArchive)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tug
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Alex Fish
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-29 00:00:00.000000000 Z
+date: 2014-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -106,6 +106,7 @@ files:
 - lib/tug/config/.tug.yml
 - lib/tug/config/config_file.rb
 - lib/tug/config/missing_config_file.rb
+- lib/tug/deployment/deployer.rb
 - lib/tug/interface/interface.rb
 - lib/tug/keychain/keychain.rb
 - lib/tug/project/project.rb
@@ -117,6 +118,7 @@ files:
 - spec/build_command_spec.rb
 - spec/command_spec.rb
 - spec/config_file_spec.rb
+- spec/deployer_spec.rb
 - spec/ipa_command_spec.rb
 - spec/keychain_spec.rb
 - spec/output.txt
@@ -152,6 +154,7 @@ test_files:
 - spec/build_command_spec.rb
 - spec/command_spec.rb
 - spec/config_file_spec.rb
+- spec/deployer_spec.rb
 - spec/ipa_command_spec.rb
 - spec/keychain_spec.rb
 - spec/output.txt