yolo 1.0.0 → 1.0.1

data/README.md

@@ -24,7 +24,7 @@ It is recommended that you have [rvm](https://rvm.io/) installed and do not inst
 ## Getting Started
 
 * [Quick Start](https://github.com/alexefish/yolo/wiki/Quick-Start)
-* [Configuration](https://github.gcom/alexefish/yolo/wiki/Configuration)
+* [Configuration](https://github.com/alexefish/yolo/wiki/Configuration)
 
 ## Release Builds
 
@@ -34,7 +34,19 @@ It is recommended that you have [rvm](https://rvm.io/) installed and do not inst
 ## Running Tests
 
 * [OCUnit & Kiwi](https://github.com/alexefish/yolo/wiki/OCUnit-&-Kiwi)
-* [Calabash](https://github.com/alexefish/yolo/wiki/Calabash)
+* [Calabash](https://github.com/alexefish/yolo/wiki/Calabashg)
+
+## Jenkins
+Running yolo from your Jenkins jobs is very simple, the following plugins are required:
+
+* [Rake Plugin](http://wiki.jenkins-ci.org/display/JENKINS/Rake+Plugin)
+* [ruby-runtime](http://jenkins-ci.org/plugin/ruby-runtime/)
+* [rvm](https://wiki.jenkins-ci.org/display/JENKINS/RVM+Plugin)
+* [Jenkins Git Plugin](http://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin)
+
+You can then simply add a rake build step to execute yolo rake tasks, e.g:
+
+![Jenkins Setup](http://i.imgur.com/7zm05pT.png)
 
 ## License 
 

data/Rakefile

@@ -5,28 +5,6 @@ namespace :gem do
   desc "Builds and then installs the gem"
   task :buildinstall do
     system 'gem build yolo.gemspec'
-    system 'gem install yolo-1.0.0.pre.gem'
+    system 'gem install yolo-1.0.1.pre.gem'
   end
 end
-
-### Sample
-
-#Yolo::Tasks::Ios::Build.new do |t|
-#  t.workspace = "Honk.xcworkspace"
-#  t.scheme = "Honk"
-#  t.formatter = XcodeBuild::Formatters::ProgressFormatter.new
-#end
-#
-#Yolo::Tasks::Ios::OCUnit.new do |t|
-#  t.workspace = "Honk.xcworkspace"
-#  t.scheme = "HonkTests"
-#  t.test_output = :junit
-#  t.formatter = XcodeBuild::Formatters::ProgressFormatter.new
-#end
-#
-#Yolo::Tasks::Ios::Calabash.new do |t|
-#  t.workspace = "Honk.xcworkspace"
-#  t.scheme = "Honk-cal"
-#  t.format = :junit
-#  t.formatter = XcodeBuild::Formatters::ProgressFormatter.new
-#end

data/lib/yolo/config/config.yml

@@ -14,3 +14,5 @@ mail:
 # Deployment settings
 deployment:
   url: http://example.com
+  api_token: example
+  team_token: example

data/lib/yolo/config/settings.rb

@@ -20,6 +20,7 @@ module Yolo
         @formatter = Yolo::Formatters::ProgressFormatter.new
         @error = Yolo::Formatters::ErrorFormatter.new
         check_config
+        update_config
         @yaml = YAML::load_file yaml_path
       end
 
@@ -50,6 +51,22 @@ module Yolo
         @yaml["deployment"]["url"] if @yaml["deployment"]["url"] and @yaml["deployment"]["url"] != "http://example.com"
       end
 
+      #
+      # The api token used for deployment
+      #
+      # @return [String] The api token defined in config.yml
+      def api_token
+        @yaml["deployment"]["api_token"] if @yaml["deployment"]["api_token"] and @yaml["deployment"]["api_token"] != "example"
+      end
+
+      #
+      # The team token used for deployment
+      #
+      # @return [String] The team token defined in config.yml
+      def team_token
+        @yaml["deployment"]["team_token"] if @yaml["deployment"]["team_token"] and @yaml["deployment"]["teamt_oken"] != "example"
+      end
+
       #
       # The mail account is the account used when sending SMTP mail
       #
@@ -90,8 +107,6 @@ module Yolo
         @yaml["mail"]["from"] if @yaml["mail"]["from"] and @yaml["mail"]["from"] != "example@example.com"
       end
 
-      private
-
       #
       # Checks for the existance of the config directory in the users home directory and creates it if not present
       #
@@ -103,6 +118,29 @@ module Yolo
         end
       end
 
+      #
+      # Checks the config file is update to the latest and adds any options that are missing
+      #
+      def update_config
+        if File.directory?(yolo_dir) and File.exist?(yaml_path)
+          @yaml = YAML::load_file yaml_path
+          unless @yaml["deployment"]["api_token"]
+            @yaml["deployment"]["api_token"] = "example"
+            File.open(yaml_path, 'w') {|f|
+              f.write(@yaml.to_yaml)
+            }
+            @formatter.config_updated(yaml_path)
+          end
+          unless @yaml["deployment"]["team_token"]
+            @yaml["deployment"]["team_token"] = "example"
+            File.open(yaml_path, 'w') {|f|
+              f.write(@yaml.to_yaml)
+            }
+            @formatter.config_updated(yaml_path)
+          end
+        end
+      end
+
       #
       # The path to the users home directory, same as ~
       #

data/lib/yolo/deployment.rb

@@ -10,3 +10,4 @@ end
 
 require 'yolo/deployment/base_deployer'
 require 'yolo/deployment/ota'
+require 'yolo/deployment/test_flight'

data/lib/yolo/deployment/base_deployer.rb

@@ -1,4 +1,4 @@
-module Yolo
+opts={}, module Yolo
   module Deployment
 
     #
@@ -23,9 +23,10 @@ module Yolo
       #
       # Deploys the package, all deployer subclasses must implement this method
       # @param  package_path [String] A full path to the package to deploy
+      # @param  opts [Hash] A hash of deployment options
       # @param  block [Block] Block fired on completing
       #
-      def deploy(package_path, &block)
+      def deploy(package_path, opts={}, &block)
       end
 
     end

data/lib/yolo/deployment/ota.rb

@@ -24,9 +24,10 @@ module Yolo
       #
       # Overides the super deploy method
       # @param  package_path [String] A full path to the package to deploy
+      # @param  opts [Hash] A hash of deployment options
       # @param  block [Block] Block fired on completing
       #
-      def deploy(package_path, &block)
+      def deploy(package_path, opts={}, &block)
         self.package_path = package_path
         @complete_block = block
 
@@ -54,7 +55,7 @@ module Yolo
       #
       def upload
         response = ""
-        IO.popen("curl -s #{self.url} -X POST -F fileContent=@\"#{self.package_path}\" -F params='#{package}'") do |io|
+        IO.popen("curl #{self.url} -X POST -# g-F fileContent=@\"#{self.package_path}\" -F params='#{package}'") do |io|
           begin
             while line = io.readline
               begin

data/lib/yolo/deployment/test_flight.rb

@@ -0,0 +1,146 @@
+module Yolo
+  module Deployment
+
+    #
+    # Deploys IPA's using testflight
+    #
+    # @author [Alex Fish]
+    #
+    class TestFlight < Yolo::Deployment::BaseDeployer
+
+      #
+      # Overides the super deploy method
+      # @param  package_path [String] A full path to the package to deploy
+      # @param  opts [Hash] A hash of deployment options
+      # @param  block [Block] Block fired on completing
+      #
+      def deploy(package_path, opts={}, &block)
+        response = ""
+        @completion_block = block
+        @progress_formatter = Yolo::Formatters::ProgressFormatter.new
+        @progress_formatter.deploying_ipa(package_path)
+
+        IO.popen(curl_string(package_path, opts)) do |io|
+          begin
+            while line = io.readline
+              begin
+                response << line
+              rescue StandardError => e
+                 @error_formatter.deploy_failed("ParserError: #{e}")
+              end
+            end
+          rescue EOFError
+            #@error_formatter.deploy_failed("ParserError")
+           end
+        end
+        upload_complete(response)
+      end
+
+      private
+
+      #
+      # Parses the response json and calls the completion block
+      # @param  response [String] The request response
+      #
+      def upload_complete(response)
+        json = nil
+        begin
+          json = JSON.parse(response)
+        rescue JSON::ParserError
+          @error_formatter.deploy_failed("\n  ParserError: Deployment server response is not JSON")
+          return
+        end
+
+        unless json
+          @error_formatter.deploy_failed("\n  ParserError: Deployment server response is not JSON")
+          return
+        end
+
+        url = json["install_url"]
+
+        @completion_block.call(url,nil)
+        @progress_formatter.deploy_complete(url,nil)
+      end
+
+      #
+      # Parses the deploy options and returns a string for use in curl
+      # @param  opts [Hash] The options hash
+      #
+      # @return [String] A comma seperated string of distribution lists
+      def distribution_lists(opts)
+        @lists = ""
+        if opts[:distribution_lists]
+          @lists = opts[:distribution_lists].join(",")
+        end
+        @lists
+      end
+
+      #
+      # Parses the options and return a notify string for use in curl
+      # @param  opts [Hash] The deployment options hash
+      #
+      # @return [String] True or False depending on the options
+      def notify(opts)
+        @notify = false
+        if opts[:notify]
+          @notify = opts[:notify].to_s.capitalize
+        end
+        @notify
+      end
+
+      #
+      # Gets the api token defined in the users config.yml
+      #
+      # @return [String] The deployment API token defined in config.yml
+      def api_token
+        token = Yolo::Config::Settings.instance.api_token
+        unless token
+          @error_formatter.no_api_token
+          token = ""
+        end
+        token
+      end
+
+      #
+      # Gets the team token defined in the users config.yml
+      #
+      # @return [String] The deployment team token defined in config.yml
+      def team_token
+        token = Yolo::Config::Settings.instance.team_token
+        unless token
+          @error_formatter.no_team_token
+          token = ""
+        end
+        token
+      end
+
+      #
+      # Returns a notes string from the Release Notes module, empty if none are set
+      #
+      # @return [String] The release notes
+      def notes
+        notes = Yolo::Tools::Ios::ReleaseNotes.plaintext
+        notes = "No notes provided" unless notes
+        notes
+      end
+
+      #
+      # Generates the CURL command string for test flight distribution
+      # @param package_path The path to the package
+      # @param  opts [Hash] The options array
+      #
+      # @return [String] The CURL command
+      def curl_string(package_path, opts)
+        string = "curl http://testflightapp.com/api/builds.json -X POST -# "
+        string = string + "-F file=@#{package_path} "
+        string = string + "-F api_token='#{api_token}' " if api_token.length > 0
+        string = string + "-F team_token='#{team_token}' " if team_token.length > 0
+        string = string + "-F notes='#{notes}' " if notes.length > 0
+        string = string + "-F notify=#{notify(opts)}" if opts
+        string = string + "-F distribution_lists=#{distribution_lists(opts)}" if opts and distribution_lists(opts).length > 0
+        string
+      end
+
+    end
+  end
+end

data/lib/yolo/formatters/error_formatter.rb

@@ -46,6 +46,20 @@ module Yolo
         puts red("No deploy url found, please specify one in ~/.yolo/config.yml")
       end
 
+      #
+      # Outputs a red string stating that no API token is defined
+      #
+      def no_api_token
+        puts red("No API token is defined in config.yml")
+      end
+
+      #
+      # Outputs a red string stating that no team token is defined
+      #
+      def no_team_token
+        puts red("No team token is defined in config.yml")
+      end
+
       #
       # Outputs a red string stating that email notification failed because of missing details
       #

data/lib/yolo/formatters/progress_formatter.rb

@@ -24,6 +24,14 @@ module Yolo
         puts green("Setup complete")
       end
 
+      #
+      # Outputs a green string stating that the config file was updated
+      # @param  config [String] The path to the config file
+      #
+      def config_updated(config)
+        puts green("Config updated at: #{config}")
+      end
+
       #
       # Outputs an underlined bold string stating that the ipa is being generated
       #
@@ -139,9 +147,11 @@ module Yolo
         puts green("URL")
         puts green(url)
         puts
-        puts green("Password")
-        puts green(password)
-        puts
+        if password
+          puts green("Password")
+          puts green(password)
+          puts
+        end
       end
 
       #

data/lib/yolo/notify/ios/ota_email.rb

@@ -39,7 +39,11 @@ MESSAGE_END
 
           content = content.gsub("YOLO.TITLE",opts[:title])
           content = content.gsub("YOLO.CONTENT",markdown)
-          content = content.gsub("YOLO.PASSWORD","<h3>Password</h3><hr><p>#{opts[:ota_password]}</p>")
+          if opts[:ota_password] and opts[:ota_password].length > 0
+            content = content.gsub("YOLO.PASSWORD","<h3>Password</h3><hr><p>#{opts[:ota_password]}</p>")
+          else
+            content = content.gsub("YOLO.PASSWORD","")
+          end
           content = content.gsub("YOLO.LINK",opts[:ota_url])
           content
         end

data/lib/yolo/tasks/ios/release.rb

@@ -14,6 +14,8 @@ module Yolo
         attr_accessor :mail_to
         # The deployment class to use when deploying
         attr_accessor :deployment
+        # A Hash of additional options
+        attr_accessor :options
 
         #
         # Initializes the class with default settings
@@ -129,14 +131,17 @@ module Yolo
             return
           end
 
-          klass.deploy(ipa_path) do |url, password|
-            @emailer.send(
-              :to => self.mail_to,
-              :ota_url => url,
-              :ota_password => password,
-              :subject => "New #{name} build: #{version}",
-              :title => name
-            )
+          klass.deploy(ipa_path, options) do |url, password|
+            if url
+              mail_options = {
+                :to => self.mail_to,
+                :ota_url => url,
+                :subject => "New #{name} build: #{version}",
+                :title => name
+              }
+              mail_options[:ota_password] = password if password
+              @emailer.send(mail_options)
+            end
           end
         end
 

data/lib/yolo/tools/ios/release_notes.rb

@@ -40,6 +40,24 @@ module Yolo
           `open #{directory}/release_notes.md`
         end
 
+        #
+        # Returns a plaintext string of the release notes file
+        #
+        # @return [String] The release notes as plain text
+        def self.plaintext
+          notes = "#{Dir.pwd}/release_notes.md"
+          unless File.exist?(notes)
+            error_formatter = Yolo::Formatters::ErrorFormatter.new
+            error_formatter.no_notes(notes)
+            return ""
+          end
+
+          file = File.open(notes, "r")
+          file_content = file.read
+
+          file_content
+        end
+
         #
         # Uses Redcarpet to parse the release notes markdown file into html.
         #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yolo
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2013-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xcodebuild-rb
@@ -75,7 +75,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A ruby interface to Continuous integration
+description: yolo is a RubyGem which provides a Ruby interface to Continuous Integration
+  build tools. yolo is currently geared towards the Xcode toolchain and iOS development.
 email: alex@alexefish.com
 executables: []
 extensions: []
@@ -87,6 +88,7 @@ files:
 - lib/yolo/config.rb
 - lib/yolo/deployment/base_deployer.rb
 - lib/yolo/deployment/ota.rb
+- lib/yolo/deployment/test_flight.rb
 - lib/yolo/deployment.rb
 - lib/yolo/formatters/error_formatter.rb
 - lib/yolo/formatters/progress_formatter.rb