rhc 1.27.4 → 1.28.5

data/lib/rhc/commands/base.rb

@@ -29,8 +29,22 @@ class RHC::Commands::Base
     # should be through this call pattern.
     def rest_client(opts={})
       @rest_client ||= begin
-          auth = RHC::Auth::Basic.new(options)
-          auth = RHC::Auth::Token.new(options, auth, token_store) if (options.use_authorization_tokens || options.token) && !(options.rhlogin && options.password)
+          core_auth = if (options.ssl_client_cert_file && options.ssl_client_key_file)
+            RHC::Auth::X509.new(options)
+          else
+            RHC::Auth::Basic.new(options)
+          end
+
+          # Specifying a username and password on the CLI trumps token
+          # authentication.
+          auth = if options.rhlogin && options.password
+            RHC::Auth::Basic.new(options)
+          elsif (options.use_authorization_tokens || options.token)
+            RHC::Auth::Token.new(options, core_auth, token_store)
+          else
+            core_auth
+          end
+
           debug "Authenticating with #{auth.class}"
           client_from_options(:auth => auth)
         end

data/lib/rhc/commands/env.rb

@@ -93,7 +93,7 @@ module RHC::Commands
       confirm_action "Are you sure you wish to remove the environment variable(s) above from application '#{rest_app.name}'?"
       say 'Removing environment variable(s) ... '
       rest_app.unset_environment_variables(env)
-      success 'removed'
+      success 'done'
 
       0
     end
@@ -109,6 +109,7 @@ module RHC::Commands
     takes_application :argument => true
     option ["--table"], "Format the output list as a table"
     option ["--quotes"], "Format the output list with double quotes for env var values"
+    alias_action :"envs", :root_command => true
     def list(app)
       rest_app = find_app
       rest_env_vars = rest_app.environment_variables

data/lib/rhc/commands/region.rb

@@ -0,0 +1,27 @@
+require 'rhc/commands/base'
+
+module RHC::Commands
+  class Region < Base
+    summary "Display the regions and zones available on the OpenShift server"
+    default_action :list
+
+    summary "List the regions and zones available on the OpenShift server"
+    alias_action :"regions", :root_command => true
+    def list
+      regions = rest_client.regions
+
+      raise RHC::NoRegionConfiguredException if regions.empty?
+      
+      paragraph{ say "Server #{options.server}" }
+
+      regions.sort.each do |region|
+        display_region(region)
+      end
+
+      paragraph{ say "To create an app in a specific region use 'rhc create-app <name> <cartridge> --region <region>'." }
+
+      0
+    end
+
+  end
+end

data/lib/rhc/commands/server.rb

@@ -46,7 +46,6 @@ module RHC::Commands
       say "Connected to #{openshift_server}"
 
       if openshift_online_server?
-        #status = decode_json(get("#{openshift_url}/app/status/status.json").body)
         status = rest_client.request(:method => :get, :url => "#{openshift_url}/app/status/status.json", :lazy_auth => true){ |res| decode_json(res.content) }
         open = status['open']
 
@@ -55,9 +54,9 @@ module RHC::Commands
         open.each do |i|
           i = i['issue']
           say color("%-3s %s" % ["##{i['id']}", i['title']], :bold)
-          items = i['updates'].map{ |u| [u['description'], date(u['created_at'])] }
-          items.unshift ['Opened', date(i['created_at'])]
-          table(items, :align => [nil,:right], :join => '  ').each{ |s| say "    #{s}" }
+          items = i['updates'].map{ |u| [date(u['created_at']), u['description']] }
+          items.unshift [date(i['created_at']), 'Opened']
+          say table(items, :align => [nil,:left], :join => '  ')
         end
         say "\n"
         warn pluralize(open.length, "open issue")
@@ -76,7 +75,7 @@ module RHC::Commands
       When adding a new server users can optionally provide a 'nickname'
       that will allow to easily switch between servers. 
       DESC
-    syntax "<hostname> [<nickname>] [--rhlogin LOGIN] [--[no-]use-authorization-tokens] [--[no-]insecure]"
+    syntax "<hostname> [<nickname>] [--rhlogin LOGIN] [--[no-]use-authorization-tokens] [--[no-]insecure] [--use] [--skip-wizard] [--timeout SECONDS] [--ssl-ca-file FILE] [--ssl-client-cert-file FILE] [--ssl-version VERSION]"
     argument :hostname, "Hostname of the server you are adding", ["--server HOSTNAME"]
     argument :nickname, "Optionally provide a nickname to the server you are adding (e.g. 'development', 'production', 'online')", ["--nickname NICKNAME"], :optional => true
     option ["-l", "--rhlogin LOGIN"], "Change the default OpenShift login used on this server"
@@ -84,10 +83,14 @@ module RHC::Commands
     option ["--[no-]insecure"], "If true, certificate errors will be ignored"
     option ["--use"], "If provided, the server being added will be set as default (same as 'rhc server use')"
     option ["--skip-wizard"], "If provided, the wizard will be skipped and a session token will not be estabilished"
+    option ["--timeout SECONDS"], "The default timeout for operations on this server", :type => Integer
+    option ["--ssl-ca-file FILE"], "An SSL certificate CA file (may contain multiple certs) to be used on this server", :type => CertificateFile, :optional => true
+    option ["--ssl-client-cert-file FILE"], "An SSL x509 client certificate file to be used on this server", :type => CertificateFile, :optional => true
+    option ["--ssl-version VERSION"], "The version of SSL to use to be used on this server", :type => SSLVersion, :optional => true
     def add(hostname, nickname)
       raise ArgumentError, "The --use and --skip-wizard options cannot be used together." if options.use && options.skip_wizard
 
-      attrs = [:login, :use_authorization_tokens, :insecure, :timeout, :ssl_version, :ssl_client_cert_file, :ssl_ca_file]
+      attrs = [:login, :use_authorization_tokens, :insecure, :timeout, :ssl_version, :ssl_client_cert_file, :ssl_client_key_file, :ssl_ca_file]
 
       server = server_configs.add(hostname, 
         attrs.inject({:nickname => nickname}){ |h, (k, v)| h[k] = options[k == :login ? :rhlogin : k]; h })
@@ -132,7 +135,7 @@ module RHC::Commands
     def use(server)
       server = server_configs.find(server)
 
-      attrs = [:login, :use_authorization_tokens, :insecure, :timeout, :ssl_version, :ssl_client_cert_file, :ssl_ca_file]
+      attrs = [:login, :use_authorization_tokens, :insecure, :timeout, :ssl_version, :ssl_client_cert_file, :ssl_client_key_file, :ssl_ca_file]
 
       if wizard_to_server(server.hostname, true, attrs.inject({}){ |h, (k, v)| h[k] = server.send(k); h })
         paragraph { success "Now using '#{server.hostname}'" }
@@ -162,7 +165,7 @@ module RHC::Commands
     end
 
     summary "Update server attributes"
-    syntax "<server> [--hostname HOSTNAME] [--nickname NICKNAME] [--rhlogin LOGIN] [--[no-]use-authorization-tokens] [--[no-]insecure]"
+    syntax "<server> [--hostname HOSTNAME] [--nickname NICKNAME] [--rhlogin LOGIN] [--[no-]use-authorization-tokens] [--[no-]insecure] [--use] [--skip-wizard] [--timeout SECONDS] [--ssl-ca-file FILE] [--ssl-client-cert-file FILE] [--ssl-version VERSION]"
     argument :server, "Server hostname or nickname to be configured", ["--server SERVER"]
     option ["--hostname HOSTNAME"], "Change the hostname of this server"
     option ["--nickname NICKNAME"], "Change the nickname of this server"
@@ -171,12 +174,16 @@ module RHC::Commands
     option ["--[no-]insecure"], "If true, certificate errors will be ignored"
     option ["--use"], "If provided, the server being configured will be set as default (same as 'rhc server use')"
     option ["--skip-wizard"], "If provided, the wizard will be skipped and a session token will not be estabilished"
+    option ["--timeout SECONDS"], "The default timeout for operations on this server", :type => Integer
+    option ["--ssl-ca-file FILE"], "An SSL certificate CA file (may contain multiple certs) to be used on this server", :type => CertificateFile, :optional => true
+    option ["--ssl-client-cert-file FILE"], "An SSL x509 client certificate file to be used on this server", :type => CertificateFile, :optional => true
+    option ["--ssl-version VERSION"], "The version of SSL to use to be used on this server", :type => SSLVersion, :optional => true
     def configure(server)
       raise ArgumentError, "The --use and --skip-wizard options cannot be used together." if options.use && options.skip_wizard
 
       server = server_configs.find(server)
 
-      attrs = [:hostname, :nickname, :login, :use_authorization_tokens, :insecure, :timeout, :ssl_version, :ssl_client_cert_file, :ssl_ca_file].inject({}){ |h, (k, v)| v = options[k == :login ? :rhlogin : k]; h[k] = (v.nil? ? server.send(k) : v); h }
+      attrs = [:hostname, :nickname, :login, :use_authorization_tokens, :insecure, :timeout, :ssl_version, :ssl_client_cert_file, :ssl_client_key_file, :ssl_ca_file].inject({}){ |h, (k, v)| v = options[k == :login ? :rhlogin : k]; h[k] = (v.nil? ? server.send(k) : v); h }
 
       raise RHC::ServerNicknameExistsException.new(options.nickname) if options.nickname && 
         server_configs.nickname_exists?(options.nickname) && 
@@ -213,10 +220,12 @@ module RHC::Commands
         options['server'] = hostname
         options['rhlogin'] = args[:login] if args[:login]
         options['use_authorization_tokens'] = args[:use_authorization_tokens] unless args[:use_authorization_tokens].nil?
+        options['create_token'] = args[:use_authorization_tokens] unless args[:use_authorization_tokens].nil?
         options['insecure'] = args[:insecure] unless args[:insecure].nil?
-        options['timeout'] = args[:timeout] unless args[:timeout].nil?
+        options['timeout'] = args[:timeout]
         options['ssl_version'] = args[:ssl_version]
         options['ssl_client_cert_file'] = args[:ssl_client_cert_file]
+        options['ssl_client_key_file'] = args[:ssl_client_key_file]
         options['ssl_ca_file'] = args[:ssl_ca_file]
         RHC::ServerWizard.new(config, options, server_configs, set_default).run
       end

data/lib/rhc/commands/sshkey.rb

@@ -22,6 +22,7 @@ module RHC::Commands
 
     summary 'Display all the SSH keys for your account'
     syntax ''
+    alias_action :"sshkeys", :root_command => true
     def list
       keys = rest_client.sshkeys.each{ |key| paragraph{ display_key(key) } }
 

data/lib/rhc/config.rb

@@ -61,6 +61,7 @@ module RHC
       :insecure                 => [nil,               :boolean,      "If true, certificate errors will be ignored.\nWARNING: This may allow others to eavesdrop on your communication with OpenShift."],
       :ssl_version              => [nil,               nil,           'The SSL protocol version to use when connecting to this server'],
       :ssl_client_cert_file     => [nil,               :path_to_file, 'A client certificate file for use with your server'],
+      :ssl_client_key_file      => [nil, :path_to_file, 'The corresponding key for the client certificate'],
       :ssl_ca_file              => [nil,               :path_to_file, 'A file containing CA one or more certificates'],
     }
 

data/lib/rhc/context_helper.rb

@@ -83,17 +83,7 @@ module RHC
     end
 
     def find_membership_container(opts={})
-      domain, app =
-        if options.target.present?
-          options.target.split(/\//)
-        elsif options.namespace || options.app
-          if options.app =~ /\//
-            options.app.split(/\//)
-          else
-            [options.namespace || namespace_context, options.app]
-          end
-        end
-
+      domain, app = discover_domain_and_app
       if options.team_id.present?
         rest_client.find_team_by_id(options.team_id)
       elsif options.team_name.present?
@@ -161,5 +151,17 @@ module RHC
 
       domain.name
     end
+
+    def discover_domain_and_app
+      if options.target.present?
+        options.target.split(/\//)
+      elsif options.namespace || options.app
+        if options.app =~ /\//
+          options.app.split(/\//)
+        else
+          [options.namespace || namespace_context, options.app]
+        end
+      end
+    end
   end
 end

data/lib/rhc/exceptions.rb

@@ -109,6 +109,18 @@ module RHC
     end
   end
 
+  class RegionsAndZonesNotSupportedException < Exception
+    def initialize(message="Server does not support regions and zones")
+      super message, 168
+    end
+  end
+
+  class NoRegionConfiguredException < Exception
+    def initialize(message="Server doesn't have any regions or zones configured")
+      super message, 169
+    end
+  end
+
   class GitPermissionDenied < GitException; end
   class GitDirectoryExists < GitException; end
 

data/lib/rhc/helpers.rb

@@ -117,7 +117,7 @@ module RHC
     global_option '--raw', "Do not format the output from the requested operations.", :hide => true
     global_option '--always-prefix', "Include the gear prefix on all output from the server.", :hide => true
 
-    OptionParser.accept(SSLVersion = Class.new){ |s| OpenSSL::SSL::SSLContext::METHODS.find{ |m| m.to_s.downcase == s.downcase } or raise OptionParser::InvalidOption.new(nil, "The provided SSL version '#{s}' is not valid. Supported values: #{OpenSSL::SSL::SSLContext::METHODS.map(&:to_s).map(&:downcase).join(', ')}") }
+    OptionParser.accept(SSLVersion = Class.new){ |s| parse_ssl_version(s) }
     global_option '--ssl-version VERSION', SSLVersion, "The version of SSL to use", :hide => true do |value|
       raise RHC::Exception, "You are using an older version of the httpclient gem which prevents the use of --ssl-version.  Please run 'gem update httpclient' to install a newer version (2.2.6 or newer)." unless HTTPClient::SSLConfig.method_defined? :ssl_version
     end
@@ -127,6 +127,9 @@ module RHC
     global_option '--ssl-client-cert-file FILE', "An SSL x509 client certificate file", :hide => true do |value|
       debug certificate_file(value)
     end
+    global_option '--ssl-client-key-file FILE', "An RSA client certificate key", :hide => true do |value|
+      debug certificate_key(value)
+    end
 
     global_option('--timeout SECONDS', Integer, 'The timeout for operations') do |value|
       raise RHC::Exception, "Timeout must be a positive integer" unless value > 0
@@ -150,6 +153,8 @@ module RHC
         raise OptionParser::InvalidOption.new(nil, "The provided role '#{s}' is not valid. Supported values: #{ROLES.keys.join(', ')}")
     end
 
+    OptionParser.accept(CertificateFile = Class.new) {|s| certificate_file(s); s}
+
     def role_name(s)
       ROLES[s.downcase]
     end
@@ -196,7 +201,6 @@ module RHC
     def ssl_options
       {
         :ssl_version => options.ssl_version,
-        :client_cert => certificate_file(options.ssl_client_cert),
         :ca_file => options.ssl_ca_file && File.expand_path(options.ssl_ca_file),
         :verify_mode => options.insecure ? OpenSSL::SSL::VERIFY_NONE : nil,
       }.delete_if{ |k,v| v.nil? }
@@ -209,6 +213,16 @@ module RHC
       raise OptionParser::InvalidOption.new(nil, "The certificate '#{file}' cannot be loaded: #{e.message} (#{e.class})")
     end
 
+    def certificate_key(file)
+      file && OpenSSL::PKey::RSA.new(IO.read(File.expand_path(file)))
+    rescue => e
+      debug e
+      raise OptionParser::InvalidOption.new(nil, "The key '#{file}' cannot be loaded: #{e.message} (#{e.class})")
+    end
+
+    def parse_ssl_version(version)
+      OpenSSL::SSL::SSLContext::METHODS.find{ |m| m.to_s.downcase == version.to_s.downcase } or raise OptionParser::InvalidOption.new(nil, "The provided SSL version '#{version}' is not valid. Supported values: #{OpenSSL::SSL::SSLContext::METHODS.map(&:to_s).map(&:downcase).join(', ')}") unless version.nil?
+    end
 
     #
     # Output helpers
@@ -281,10 +295,14 @@ module RHC
 
     # OVERRIDE: Replaces default commander behavior
     def color(item, *args)
-      if item.is_a? Array
-        item.map{ |i| $terminal.color(i, *args) }
-      else
-        $terminal.color(item, *args)
+      unless (options.raw rescue false)
+        if item.is_a? Array
+          item.map{ |i| $terminal.color(i, *args) }
+        else
+          $terminal.color(item, *args)
+        end
+      else 
+        item
       end
     end
 
@@ -341,7 +359,8 @@ module RHC
         :use_authorization_tokens => 'Use Auth Tokens',
         :ssl_ca_file     => 'SSL Cert CA File',
         :ssl_version     => 'SSL Version',
-        :ssl_client_cert_file => 'SSL x509 Client Cert File'
+        :ssl_client_cert_file => 'SSL x509 Client Cert File',
+        :zones           => 'Available Zones'
       })
 
       headings[value]

data/lib/rhc/output_helpers.rb

@@ -30,6 +30,7 @@ module RHC
                 :creation_time,
                 (:id if ids),
                 (:allowed_gear_sizes unless domain.allowed_gear_sizes.nil?),
+                (:suffix unless domain.suffix.nil? || openshift_online_server?),
                 :compact_members
               ),
               :delete => true
@@ -96,6 +97,26 @@ module RHC
       end
     end
 
+    def display_region(region)
+      paragraph do
+        header ["Region '#{region.name}'", "(uuid: #{region.uuid})", ("(default)" if region.default?)], {:color => (:green if region.default?)} do
+          section(:bottom => 1) do
+            say format_table \
+              nil,
+              get_properties(
+                region,
+                :description,
+                :zones
+              ),
+              {
+                :delete => true,
+                :color => (:green if region.default?)
+              }
+          end
+        end
+      end
+    end
+
     def format_cart_header(cart)
       [
         cart.name,

data/lib/rhc/rest.rb

@@ -18,6 +18,7 @@ module RHC
     autoload :GearGroup,            'rhc/rest/gear_group'
     autoload :Key,                  'rhc/rest/key'
     autoload :Membership,           'rhc/rest/membership'
+    autoload :Region,               'rhc/rest/region'
     autoload :Team,                 'rhc/rest/team'
     autoload :User,                 'rhc/rest/user'
 

data/lib/rhc/rest/application.rb

@@ -10,6 +10,7 @@ module RHC
                   :scalable, :health_check_path, :embedded, :gear_count,
                   :ssh_url, :building_app, :cartridges, :initial_git_url,
                   :auto_deploy, :deployment_branch, :deployment_type, :keep_deployments, :deployments
+                  :region
       alias_method :domain_name, :domain_id
 
       # Query helper to say consistent with cartridge
@@ -100,6 +101,10 @@ module RHC
         gear['ssh_url'] or raise NoPerGearOperations
       end
 
+      def region
+        gears.first['region'] rescue nil
+      end
+
       def tidy
         debug "Starting application #{name}"
         rest_method 'TIDY', :event => "tidy"

data/lib/rhc/rest/client.rb

@@ -59,6 +59,15 @@ module RHC
         @cartridges ||= api.rest_method("LIST_CARTRIDGES", nil, :lazy_auth => true)
       end
 
+      def regions
+        debug "Getting all regions and zones available"
+        if supports_regions_and_zones?
+          @regions ||= api.rest_method("LIST_REGIONS")
+        else
+          raise RHC::RegionsAndZonesNotSupportedException
+        end
+      end
+
       def user
         debug "Getting user info"
         @user ||= api.rest_method "GET_USER"
@@ -156,6 +165,12 @@ module RHC
         request(:url => link_show_application_by_domain_name(domain, application, "gear_groups"), :method => "GET", :payload => options)
       end
 
+      def find_application_gear_groups_endpoints(domain, application, options={})
+        precheck_domain_id(domain)
+        precheck_application_id(application)
+        request(:url => link_show_application_by_domain_name(domain, application, "gear_groups"), :method => "GET", :payload => options.merge(:include => 'endpoints'))
+      end
+
       def find_application_aliases(domain, application, options={})
         precheck_domain_id(domain)
         precheck_application_id(application)
@@ -266,6 +281,10 @@ module RHC
         api.supports? 'ADD_AUTHORIZATION'
       end
 
+      def supports_regions_and_zones?
+        api.supports? :LIST_REGIONS
+      end
+
       def authorizations
         raise AuthorizationsNotSupported unless supports_sessions?
         api.rest_method 'LIST_AUTHORIZATIONS'
@@ -640,6 +659,8 @@ module RHC
             RHC::Rest::Membership::Member.new(data, self)
           when 'members'
             data.map{ |json| RHC::Rest::Membership::Member.new(json, self) }
+          when 'regions'
+            data.map{ |json| Region.new(json, self) }
           else
             data
           end

data/lib/rhc/rest/domain.rb

@@ -6,7 +6,8 @@ module RHC
       define_attr :id,                  # Domain name for API version < 1.6, domain unique id otherwise
                   :name,                # Available from API version 1.6 onwards
                   :allowed_gear_sizes,  # Available from API version 1.3 onwards on compatible servers
-                  :creation_time        # Available from API version 1.3 onwards on compatible servers
+                  :creation_time,        # Available from API version 1.3 onwards on compatible servers
+                  :suffix
 
       def id
         id_and_name.first

data/lib/rhc/rest/membership.rb

@@ -143,6 +143,8 @@ module RHC::Rest
 
     def owner
       members.find(&:owner?)
+    rescue RHC::MembersNotSupported
+      nil
     end
   end
 end