turbot 0.1.36 → 0.2.0

data/dist/resources/pkg/postinstall

@@ -0,0 +1,45 @@
+#!/bin/sh
+
+usershell=$(dscl localhost -read /Local/Default/Users/$USER shell | sed -e 's/[^ ]* //')
+
+startup_files() {
+  case $(basename $usershell) in
+    zsh)
+      echo ".zlogin .zshrc .zprofile .zshenv"
+      ;;
+    bash)
+      echo ".bashrc .bash_profile .bash_login .profile"
+      ;;
+    *)
+      echo ".bash_profile .zshrc .profile"
+      ;;
+  esac
+}
+
+install_path() {
+  for file in $(startup_files); do
+    [ -f $HOME/$file ] || continue
+    (grep "Added by the Turbot" $HOME/$file >/dev/null) && break
+
+    cat <<MESSAGE >>$HOME/$file
+
+### Added by the Turbot Toolbelt
+export PATH="/usr/local/turbot/bin:\$PATH"
+MESSAGE
+
+    # done after we add to one file
+    break
+  done
+}
+
+# if the toolbelt is not returned by `which`, let's add to the PATH
+case $(which turbot) in
+  /usr/bin/turbot|/usr/local/turbot/bin/turbot)
+    ;;
+  *)
+    install_path
+    ;;
+esac
+
+# symlink binary to /usr/bin/turbot
+ln -sf /usr/local/turbot/bin/turbot /usr/bin/turbot

data/dist/resources/pkg/turbot

@@ -0,0 +1,24 @@
+#!/usr/local/turbot/ruby/bin/ruby
+# encoding: UTF-8
+
+# resolve bin path, ignoring symlinks
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+
+# add locally vendored gems to libpath
+gem_dir = File.expand_path("../../vendor/gems", bin_file)
+Dir["#{gem_dir}/**/lib"].each do |libdir|
+  $:.unshift libdir
+end
+
+# add self to libpath
+$:.unshift File.expand_path("../../lib", bin_file)
+
+# inject any code in ~/.turbot/client over top
+require "turbot/updater"
+Turbot::Updater.inject_libpath
+
+# start up the CLI
+require "turbot/cli"
+Turbot.user_agent = "turbot-toolbelt/#{Turbot::VERSION} (#{RUBY_PLATFORM}) ruby/#{RUBY_VERSION}"
+Turbot::CLI.start(*ARGV)

data/dist/resources/tgz/turbot

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# resolve bin path, ignoring symlinks
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+
+# add locally vendored gems to libpath
+gem_dir = File.expand_path("../../vendor/gems", bin_file)
+Dir["#{gem_dir}/**/lib"].each do |libdir|
+  $:.unshift libdir
+end
+
+# add self to libpath
+$:.unshift File.expand_path("../../lib", bin_file)
+
+# inject any code in ~/.turbot/client over top
+require "turbot/updater"
+Turbot::Updater.inject_libpath
+
+# start up the CLI
+require "turbot/cli"
+Turbot.user_agent = "turbot-toolbelt/#{Turbot::VERSION} (#{RUBY_PLATFORM}) ruby/#{RUBY_VERSION}"
+Turbot::CLI.start(*ARGV)

data/dist/rpm.rake

@@ -0,0 +1,35 @@
+# TODO
+# * signing
+# * yum repository for updates
+# * foreman
+
+file pkg("/yum-#{version}/turbot-#{version}.rpm") => "deb:build" do |t|
+  mkchdir(File.dirname(t.name)) do
+    deb = pkg("/apt-#{version}/turbot-#{version}.deb")
+    sh "alien --keep-version --scripts --generate --to-rpm #{deb}"
+
+    spec = "turbot-#{version}/turbot-#{version}-1.spec"
+    spec_contents = File.read(spec)
+    File.open(spec, "w") do |f|
+      # Add ruby requirement, remove benchmark file with ugly filename
+      f.puts spec_contents.sub(/\n\n/m, "\nRequires: ruby\nBuildArch: noarch\n\n").
+        sub(/^.+has_key-vs-hash\[key\].+$/, "").
+        sub(/^License: .*/, "License: MIT\nURL: http://turbot.com\n").
+        sub(/^%description/, "%description\nClient library and CLI to deploy bots on Turbot.")
+    end
+    sh "sed -i s/ruby1.9.1/ruby/ turbot-#{version}/usr/local/turbot/bin/turbot"
+
+    chdir("turbot-#{version}") do
+      sh "rpmbuild --buildroot $PWD -bb turbot-#{version}-1.spec"
+    end
+  end
+end
+
+desc "Build an .rpm package"
+task "rpm:build" => pkg("/yum-#{version}/turbot-#{version}.rpm")
+
+desc "Remove build artifacts for .rpm"
+task "rpm:clean" do
+  clean pkg("turbot-#{version}.rpm")
+  FileUtils.rm_rf("pkg/yum-#{version}") if Dir.exists?("pkg/yum-#{version}")
+end

data/dist/tgz.rake

@@ -0,0 +1,26 @@
+file pkg("turbot-#{version}.tgz") => distribution_files("tgz") do |t|
+  tempdir do |dir|
+    mkchdir("turbot-client") do
+      assemble_distribution
+      assemble_gems
+      assemble resource("tgz/turbot"), "bin/turbot", 0755
+    end
+
+    sh "chmod -R go+r turbot-client"
+    sh "sudo chown -R 0:0 turbot-client"
+    sh "tar czf #{t.name} turbot-client"
+    sh "sudo chown -R $(whoami) turbot-client"
+  end
+end
+
+task "tgz:build" => pkg("turbot-#{version}.tgz")
+
+task "tgz:clean" do
+  clean pkg("turbot-#{version}.tgz")
+end
+
+task "tgz:release" => "tgz:build" do |t|
+  store pkg("turbot-#{version}.tgz"), "turbot-client/turbot-client-#{version}.tgz"
+  store pkg("turbot-#{version}.tgz"), "turbot-client/turbot-client-beta.tgz" if beta?
+  store pkg("turbot-#{version}.tgz"), "turbot-client/turbot-client.tgz" unless beta?
+end

data/dist/zip.rake

@@ -0,0 +1,40 @@
+require "zip"
+
+file pkg("turbot-#{version}.zip") => distribution_files("zip") do |t|
+  tempdir do |dir|
+    mkchdir("turbot-client") do
+      assemble_distribution
+      assemble_gems
+      Zip::ZipFile.open(t.name, Zip::ZipFile::CREATE) do |zip|
+        Dir["**/*"].each do |file|
+          zip.add(file, file) { true }
+        end
+      end
+    end
+  end
+end
+
+file pkg("turbot-#{version}.zip.sha256") => pkg("turbot-#{version}.zip") do |t|
+  File.open(t.name, "w") do |file|
+    file.puts Digest::SHA256.file(t.prerequisites.first).hexdigest
+  end
+end
+
+task "zip:build" => pkg("turbot-#{version}.zip")
+task "zip:sign"  => pkg("turbot-#{version}.zip.sha256")
+
+def zip_signature
+  File.read(pkg("turbot-#{version}.zip.sha256")).chomp
+end
+
+task "zip:clean" do
+  clean pkg("turbot-#{version}.zip")
+end
+
+task "zip:release" => %w( zip:build zip:sign ) do |t|
+  store pkg("turbot-#{version}.zip"), "turbot-client/turbot-client-#{version}.zip"
+  store pkg("turbot-#{version}.zip"), "turbot-client/turbot-client-beta.zip" if beta?
+  store pkg("turbot-#{version}.zip"), "turbot-client/turbot-client.zip" unless beta?
+
+  sh "turbot config:add UPDATE_HASH=#{zip_signature} -a toolbelt"
+end

data/lib/turbot/cli.rb

@@ -1,42 +1,25 @@
-load('turbot/helpers.rb') # reload helpers after possible inject_loadpath
-load('turbot/updater.rb') # reload updater after possible inject_loadpath
-
-require "turbot"
-require "turbot/command"
-require "turbot/helpers"
-
-# workaround for rescue/reraise to define errors in command.rb failing in 1.8.6
-if RUBY_VERSION =~ /^1.8.6/
-  require('turbot-api')
-  require('rest_client')
-end
-
 class Turbot::CLI
-
   extend Turbot::Helpers
 
   def self.start(*args)
     begin
-      if $stdin.isatty
-        $stdin.sync = true
-      end
-      if $stdout.isatty
-        $stdout.sync = true
-      end
-      command = args.shift.strip rescue "help"
-      Turbot::Command.load
-      trap "SIGINT" do
+      $stdout.sync = true
+      $stderr.sync = true
+
+      trap 'SIGINT' do
         # Script terminated by Control-C.
         exit 130
       end
+
+      Turbot::Command.load
+      command = args.shift.strip rescue 'help'
       Turbot::Command.run(command, args)
     rescue Interrupt
       `stty icanon echo`
-      error("Command cancelled.")
-    rescue => error
-      styled_error(error)
+      error 'Command cancelled.'
+    rescue => e
+      styled_error(e)
       exit(1)
     end
   end
-
 end

data/lib/turbot/command/auth.rb

@@ -1,85 +1,123 @@
-require "turbot/command/base"
-
-# authentication (login, logout)
+#Login or logout from Turbot
 #
 class Turbot::Command::Auth < Turbot::Command::Base
-
   # auth
   #
-  # Authenticate, display token and current user
+  #Login or logout. Display your Turbot API token or email address.
   def index
     validate_arguments!
-
     Turbot::Command::Help.new.send(:help_for_command, current_command)
   end
 
   # auth:login
   #
-  # log in with your turbot credentials
+  #Login to Turbot and save your Turbot credentials.
   #
   #Example:
   #
-  # $ turbot auth:login
-  # Enter your Turbot credentials:
-  # Email: email@example.com
-  # Password (typing will be hidden):
-  # Authentication successful.
+  #  $ turbot auth:login
+  #  Enter your Turbot email and password:
+  #  Email: email@example.com
+  #  Password (typing will be hidden):
+  #  Logged in. Saved Turbot API key.
   #
   def login
     validate_arguments!
-
-    Turbot::Auth.login
-    display "Authentication successful."
+    email_address, api_key = ask_for_email_address_and_password
+    if api_key.empty?
+      error 'Authentication failed.'
+    end
+    save_netrc_entry(email_address, api_key)
+    puts 'Authentication successful.'
   end
-
-  alias_command "login", "auth:login"
+  alias_command 'login', 'auth:login'
 
   # auth:logout
   #
-  # clear local authentication credentials
+  #Delete your Turbot credentials.
   #
   #Example:
   #
-  # $ turbot auth:logout
-  # Local credentials cleared.
+  #  $ turbot auth:logout
+  #  Deleted Turbot credentials.
   #
   def logout
     validate_arguments!
-
-    Turbot::Auth.logout
-    display "Local credentials cleared."
+    delete_netrc_entry
+    puts 'Deleted Turbot credentials.'
   end
-
-  alias_command "logout", "auth:logout"
+  alias_command 'logout', 'auth:logout'
 
   # auth:token
   #
-  # display your api token
+  #Display your Turbot API token.
   #
   #Example:
   #
-  # $ turbot auth:token
-  # ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ABCD
+  #  $ turbot auth:token
+  #  93a5c45595ed37dc9d040116
   #
   def token
     validate_arguments!
-
-    display Turbot::Auth.api_key
+    result = email_address_and_api_key[1]
+    if result
+      puts result
+    else
+      error 'not logged in'
+    end
   end
 
   # auth:whoami
   #
-  # display your turbot email address
+  #Display your Turbot email address.
   #
   #Example:
   #
-  # $ turbot auth:whoami
-  # email@example.com
+  #  $ turbot auth:whoami
+  #  email@example.com
   #
   def whoami
     validate_arguments!
+    result = email_address_and_api_key[0]
+    if result
+      puts result
+    else
+      error 'not logged in'
+    end
+  end
+
+private
+
+  ### Shell-related
 
-    display Turbot::Auth.user
+  # Prompts the user for an email address and password, and returns the email
+  # address and the user's API key.
+  #
+  # @return [Array<String>] the user's email address and API key
+  def ask_for_email_address_and_password
+    puts 'Enter your Turbot email and password.'
+
+    print 'Email: '
+    email_address = ask
+
+    print 'Password (typing will be hidden): '
+    password = running_on_windows? ? ask_for_password_on_windows : ask_for_password
+
+    puts
+
+    [email_address, get_api_key(email_address, password)]
   end
 
+  def running_on_windows?
+    RUBY_PLATFORM =~ /mswin32|mingw32/
+  end
+
+  ### API-related
+
+  # Gets the user's API key.
+  #
+  # @return [String] the API key, or the empty string if authentication fails
+  def get_api_key(email_address, password)
+    api.get_api_key_for_credentials(email_address, password)['api_key']
+  end
 end

data/lib/turbot/command/base.rb

@@ -1,19 +1,14 @@
-require "fileutils"
-require "turbot/auth"
-require "turbot/client/rendezvous"
-require "turbot/command"
-
 class Turbot::Command::Base
   include Turbot::Helpers
 
   def self.namespace
-    self.to_s.split("::").last.downcase
+    self.to_s.split('::').last.downcase
   end
 
   attr_reader :args
   attr_reader :options
 
-  def initialize(args=[], options={})
+  def initialize(args = [], options = {})
     @args = args
     @options = options
   end
@@ -21,24 +16,13 @@ class Turbot::Command::Base
   def bot
     @bot ||= if options[:bot].is_a?(String)
       options[:bot]
-    elsif ENV.has_key?('TURBOT_BOT')
+    elsif ENV['TURBOT_BOT']
       ENV['TURBOT_BOT']
-    elsif bot_from_manifest = extract_bot_from_manifest(Dir.pwd)
-      bot_from_manifest
-    else
-      # raise instead of using error command to enable rescuing when bot is optional
-      raise Turbot::Command::CommandFailed.new("No bot specified.\nRun this command from a bot folder containing a `manifest.json`,  or specify which bot to use with --bot BOT_ID.") unless options[:ignore_no_bot]
+    elsif manifest = parse_manifest
+      manifest['bot_id']
     end
   end
 
-  def api
-    Turbot::Auth.api
-  end
-
-  def turbot
-    Turbot::Auth.client
-  end
-
 protected
 
   def self.inherited(klass)
@@ -53,9 +37,9 @@ protected
   end
 
   def self.method_added(method)
-    return if self == Turbot::Command::Base
-    return if private_method_defined?(method)
-    return if protected_method_defined?(method)
+    if self == Turbot::Command::Base || private_method_defined?(method) || protected_method_defined?(method)
+      return
+    end
 
     help = extract_help_from_caller(caller.first)
     resolved_method = (method.to_s == "index") ? nil : method.to_s
@@ -73,18 +57,10 @@ protected
       :description => extract_description(help),
       :options     => extract_options(help)
     )
-
-    alias_command command.gsub(/_/, '-'), command if command =~ /_/
-  end
-
-  def self.alias_command(new, old)
-    raise "no such command: #{old}" unless Turbot::Command.commands[old]
-    Turbot::Command.command_aliases[new] = old
   end
 
-  def extract_bot
-    output_with_bang "Command::Base#extract_bot has been deprecated. Please use Command::Base#bot instead.  #{caller.first}"
-    bot
+  def self.alias_command(command_alias, command)
+    Turbot::Command.command_aliases[command_alias] = command
   end
 
   #
@@ -113,7 +89,7 @@ protected
     buffer = []
     lines = Turbot::Command.files[file]
 
-    (line_number.to_i-2).downto(0) do |i|
+    (line_number.to_i - 2).downto(0) do |i|
       line = lines[i]
       case line[0..0]
         when ""
@@ -156,37 +132,22 @@ protected
     Turbot::Command.current_command
   end
 
-  def extract_option(key)
-    options[key.dup.gsub('-','_').to_sym]
-  end
-
-  def invalid_arguments
-    Turbot::Command.invalid_arguments
-  end
-
-  def shift_argument
-    Turbot::Command.shift_argument
-  end
-
   def validate_arguments!
     Turbot::Command.validate_arguments!
   end
 
-  def extract_bot_from_manifest(dir)
-    begin
-      config = JSON.load(open("#{dir}/manifest.json").read)
-      config && config["bot_id"]
-    rescue Errno::ENOENT
+  def parse_manifest
+    path = File.join(working_directory, 'manifest.json')
+    if File.exists?(path)
+      begin
+        JSON.load(File.read(path))
+      rescue JSON::ParserError => e
+        error "`manifest.json` is invalid JSON. Consider validating it at http://pro.jsonlint.com/"
+      end
     end
   end
 
-  def escape(value)
-    turbot.escape(value)
-  end
-end
-
-module Turbot::Command
-  unless const_defined?(:BaseWithApp)
-    BaseWithApp = Base
+  def working_directory
+    Dir.pwd
   end
 end