rhc 1.14.7 → 1.15.6

data/lib/rhc/helpers.rb

@@ -141,6 +141,17 @@ module RHC
       #:nocov:
     end
 
+    ROLES = {'view' => 'viewer', 'edit' => 'editor', 'admin' => 'administrator'}
+    OptionParser.accept(Role = Class.new) do |s|
+      s.downcase!
+      (ROLES.has_key?(s) && s) or
+        raise OptionParser::InvalidOption.new(nil, "The provided role '#{s}' is not valid. Supported values: #{ROLES.keys.join(', ')}")
+    end
+
+    def role_name(s)
+      ROLES[s.downcase]
+    end
+
     def openshift_server
       to_host((options.server rescue nil) || ENV['LIBRA_SERVER'] || "openshift.redhat.com")
     end
@@ -191,7 +202,7 @@ module RHC
           :url => openshift_rest_endpoint.to_s,
           :debug => options.debug,
           :timeout => options.timeout,
-          :warn => self.class.instance_method(:warn).bind(self),
+          :warn => BOUND_WARNING,
         }.merge!(ssl_options).merge!(opts))
     end
 
@@ -211,6 +222,7 @@ module RHC
       raise OptionParser::InvalidOption.new(nil, "The certificate '#{file}' cannot be loaded: #{e.message} (#{e.class})")
     end
 
+
     #
     # Output helpers
     #
@@ -229,6 +241,11 @@ module RHC
       $terminal.debug?
     end
 
+    def exec(cmd)
+      output = Kernel.send(:`, cmd)
+      [$?.exitstatus, output]
+    end
+
     def disable_deprecated?
       ENV['DISABLE_DEPRECATED'] == '1'
     end
@@ -237,10 +254,6 @@ module RHC
       deprecated("This command is deprecated. Please use '#{correct}' instead.", short)
     end
 
-    def deprecated_option(deprecated, other)
-      deprecated("The option '#{deprecated}' is deprecated. Please use '#{other}' instead")
-    end
-
     def deprecated(msg,short = false)
       raise DeprecatedError.new(msg % ['an error','a warning',0]) if disable_deprecated?
       warn "Warning: #{msg}\n" % ['a warning','an error',1]
@@ -317,13 +330,16 @@ module RHC
       headings.merge!({
         :creation_time  => "Created",
         :expires_in_seconds => "Expires In",
-        :uuid           => "UUID",
+        :uuid           => "ID",
+        :id             => 'ID',
         :current_scale  => "Current",
         :scales_from    => "Minimum",
         :scales_to      => "Maximum",
         :gear_sizes     => "Allowed Gear Sizes",
         :consumed_gears => "Gears Used",
         :max_gears      => "Gears Allowed",
+        :max_domains    => "Domains Allowed",
+        :compact_members => "Members",
         :gear_info      => "Gears",
         :plan_id        => "Plan",
         :url            => "URL",
@@ -453,5 +469,6 @@ module RHC
       env_vars
     end
 
+    BOUND_WARNING = self.method(:warn).to_proc
   end
 end

data/lib/rhc/highline_extensions.rb

@@ -85,7 +85,7 @@ class HighLineExtension < HighLine
       end
 
       @output.print HighLine::CLEAR if color
-      @output.flush      
+      @output.flush
     end
 
     msg
@@ -211,7 +211,8 @@ class HighLineExtension < HighLine
 
     read, write = IO.pipe
 
-    unless Kernel.fork # Child process
+    unless Kernel.fork
+      # Child process
       STDOUT.reopen(write)
       STDERR.reopen(write) if STDERR.tty?
       read.close

data/lib/rhc/output_helpers.rb

@@ -1,16 +1,18 @@
 module RHC
   module OutputHelpers
 
-    def display_domain(domain, applications=nil)
+    def display_domain(domain, applications=nil, ids=false)
       paragraph do
-        header ["Domain #{domain.id}", ("(owned by #{domain.owner})" if domain.owner.present?)] do
+        header ["Domain #{domain.name}", ("(owned by #{domain.owner})" if domain.owner.present?)] do
           section(:bottom => 1) do
             say format_table \
               nil,
               get_properties(
                 domain,
                 :creation_time,
-                :allowed_gear_sizes
+                (:id if ids),
+                (:allowed_gear_sizes unless domain.allowed_gear_sizes.nil?),
+                :compact_members
               ),
               :delete => true
           end
@@ -156,7 +158,7 @@ module RHC
         values = values.to_a if values.is_a? Hash
         values.delete_if do |arr|
           arr[0] = "#{table_heading(arr.first)}:" if arr[0].is_a? Symbol
-          opts[:delete] and arr.last.blank?
+          opts[:delete] and arr.last.nil? || arr.last == ""
         end
 
         table(values, :heading => heading, :indent => heading ? '  ' : nil, :color => opts[:color])
@@ -171,6 +173,7 @@ module RHC
       def get_properties(object,*properties)
         properties.map do |prop|
           # Either send the property to the object or yield it
+          next if prop.nil?
           value = begin
                     block_given? ? yield(prop) : object.send(prop)
                   rescue ::Exception => e
@@ -178,7 +181,7 @@ module RHC
                     "<error>"
                   end
           [prop, format_value(prop,value)]
-        end
+        end.compact
       end
 
       # Format some special values
@@ -206,7 +209,7 @@ module RHC
           distance_of_time_in_words(value)
         else
           case value
-          when Array then value.join(', ')
+          when Array then value.empty? ? '<none>' : value.join(', ')
           else            value
           end
         end

data/lib/rhc/rest.rb

@@ -16,6 +16,7 @@ module RHC
     autoload :EnvironmentVariable,  'rhc/rest/environment_variable'
     autoload :GearGroup,            'rhc/rest/gear_group'
     autoload :Key,                  'rhc/rest/key'
+    autoload :Membership,           'rhc/rest/membership'
     autoload :User,                 'rhc/rest/user'
 
     class Exception < RuntimeError

data/lib/rhc/rest/application.rb

@@ -3,6 +3,8 @@ require 'uri'
 module RHC
   module Rest
     class Application < Base
+      include Membership
+
       define_attr :domain_id, :name, :creation_time, :uuid,
                   :git_url, :app_url, :gear_profile, :framework,
                   :scalable, :health_check_path, :embedded, :gear_count,
@@ -14,6 +16,14 @@ module RHC
         scalable
       end
 
+      def id
+        attributes['id'] || uuid
+      end
+
+      def domain
+        domain_id
+      end
+
       def scalable_carts
         return [] unless scalable?
         carts = cartridges.select(&:scalable?)
@@ -58,10 +68,6 @@ module RHC
           end
       end
 
-      def domain
-        domain_id
-      end
-
       def gear_info
         { :gear_count => gear_count, :gear_profile => gear_profile } unless gear_count.nil?
       end

data/lib/rhc/rest/attributes.rb

@@ -29,4 +29,8 @@ module RHC::Rest::AttributesClass
       end
     end
   end
+
+  def model_name
+    name.split("::").last
+  end
 end

data/lib/rhc/rest/base.rb

@@ -51,9 +51,10 @@ module RHC
         end
       end
 
-      def link_href(sym, params=nil, &block)
+      def link_href(sym, params=nil, resource=nil, &block)
         if (l = link(sym)) && (h = l['href'])
           h = h.gsub(/:\w+/){ |s| params[s].nil? ? s : CGI.escape(params[s]) } if params
+          h = "#{h}/#{resource}" if resource
           return h
         end
         yield if block_given?

data/lib/rhc/rest/cartridge.rb

@@ -34,6 +34,10 @@ module RHC
         Array(attribute(:tags))
       end
 
+      def gear_storage
+        (base_gear_storage + additional_gear_storage) * 1024 * 1024 * 1024
+      end
+
       def additional_gear_storage
         attribute(:additional_gear_storage).to_i rescue 0
       end

data/lib/rhc/rest/client.rb

@@ -14,10 +14,11 @@ module RHC
     # callable from the client for convenience.
     #
     module ApiMethods
-      def add_domain(id)
-        debug "Adding domain #{id}"
+      def add_domain(id, payload={})
+        debug "Adding domain #{id} with options #{payload.inspect}"
         @domains = nil
-        api.rest_method "ADD_DOMAIN", :id => id
+        payload.delete_if{ |k,v| k.nil? or v.nil? }
+        api.rest_method "ADD_DOMAIN", {:id => id}.merge(payload)
       end
 
       def domains
@@ -56,37 +57,38 @@ module RHC
       def find_domain(id)
         debug "Finding domain #{id}"
         if link = api.link_href(:SHOW_DOMAIN, ':name' => id)
-          request({
-            :url => link,
-            :method => "GET",
-          })
+          request(:url => link, :method => "GET")
         else
-          domains.find{ |d| d.id.downcase == id.downcase }
+          domains.find{ |d| d.name.downcase == id.downcase }
         end or raise DomainNotFoundException.new("Domain #{id} not found")
       end
 
       def find_application(domain, application, options={})
-        response = request({
-          :url => link_show_application_by_domain_name(domain, application),
-          :method => "GET",
-          :payload => options
-        })
+        request(:url => link_show_application_by_domain_name(domain, application), :method => "GET", :payload => options)
       end
 
       def find_application_gear_groups(domain, application, options={})
-        response = request({
-          :url => link_show_application_by_domain_name(domain, application, "gear_groups"),
-          :method => "GET",
-          :payload => options
-        })
+        request(:url => link_show_application_by_domain_name(domain, application, "gear_groups"), :method => "GET", :payload => options)
       end
 
       def find_application_aliases(domain, application, options={})
-        response = request({
-          :url => link_show_application_by_domain_name(domain, application, "aliases"),
-          :method => "GET",
-          :payload => options
-        })
+        request(:url => link_show_application_by_domain_name(domain, application, "aliases"), :method => "GET", :payload => options)
+      end
+
+      def find_application_by_id(id, options={})
+        if api.supports? :show_application
+          request(:url => link_show_application_by_id(id), :method => "GET", :payload => options)
+        else
+          applications.find{ |a| a.id == id }
+        end or raise ApplicationNotFoundException.new("Application with id #{id} not found")
+      end
+
+      def find_application_by_id_gear_groups(id, options={})
+        if api.supports? :show_application
+          request(:url => link_show_application_by_id(id, 'gear_groups'), :method => "GET", :payload => options)
+        else
+          applications.find{ |a| return a.gear_groups if a.id == id }
+        end or raise ApplicationNotFoundException.new("Application with id #{id} not found")
       end
 
       def link_show_application_by_domain_name(domain, application, *args)
@@ -98,6 +100,10 @@ module RHC
         ].concat(args).map{ |s| URI.escape(s) }.join("/")
       end
 
+      def link_show_application_by_id(id, *args)
+        api.link_href(:SHOW_APPLICATION, {':id' => id}, *args)
+      end
+
       def link_show_domain_by_name(domain, *args)
         api.link_href(:SHOW_DOMAIN, ':id' => domain)
       end
@@ -191,6 +197,14 @@ module RHC
           h
         end
       end
+
+      def reset
+        (instance_variables - [
+          :@end_point, :@debug, :@preferred_api_versions, :@auth, :@options, :@headers,
+          :@last_options, :@httpclient, :@self_signed, :@current_api_version, :@api
+        ]).each{ |sym| instance_variable_set(sym, nil) }
+        self
+      end
     end
 
     class Client < Base
@@ -368,13 +382,14 @@ module RHC
 
           if !@httpclient || @last_options != options
             @httpclient = RHC::Rest::HTTPClient.new(:agent_name => user_agent).tap do |http|
+              debug "Created new httpclient"
               http.cookie_manager = nil
               http.debug_dev = $stderr if ENV['HTTP_DEBUG']
 
-              options.select{ |sym, value| http.respond_to?("#{sym}=") }.map{ |sym, value| http.send("#{sym}=", value) }
+              options.select{ |sym, value| http.respond_to?("#{sym}=") }.each{ |sym, value| http.send("#{sym}=", value) }
 
               ssl = http.ssl_config
-              options.select{ |sym, value| ssl.respond_to?("#{sym}=") }.map{ |sym, value| ssl.send("#{sym}=", value) }
+              options.select{ |sym, value| ssl.respond_to?("#{sym}=") }.each{ |sym, value| ssl.send("#{sym}=", value) }
               ssl.add_trust_ca(options[:ca_file]) if options[:ca_file]
               ssl.verify_callback = default_verify_callback
 
@@ -451,6 +466,7 @@ module RHC
 
           # remove all unnecessary options
           options.delete(:lazy_auth)
+          options.delete(:accept)
 
           args = [options.delete(:method), options.delete(:url), query, payload, headers, true]
           [httpclient_for(options, auth), args]

data/lib/rhc/rest/domain.rb

@@ -1,15 +1,30 @@
 module RHC
   module Rest
     class Domain < Base
-      define_attr :id, :allowed_gear_sizes, :creation_time
+      include Membership
 
-      def allowed_gear_sizes
-        Array(attribute(:allowed_gear_sizes))
-      end
+      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
 
-      def owner
-        if o = Array(attribute(:members)).find{ |m| m['owner'] == true }
-          o['name']
+      def id
+        id_and_name.first
+      end
+      def name
+        id_and_name.last
+      end
+      def id_and_name
+        id = @id || attributes['id']
+        name = @name || attributes['name']
+        if name.present?
+          if id == name
+            [nil, name]
+          else
+            [id, name]
+          end
+        else
+          [nil, id]
         end
       end
 
@@ -57,12 +72,17 @@ module RHC
         rest_method "LIST_APPLICATIONS", options
       end
 
-      def update(new_id)
+      def rename(new_id)
         debug "Updating domain #{id} to #{new_id}"
         # 5 minute timeout as this may take time if there are a lot of apps
         rest_method "UPDATE", {:id => new_id}, {:timeout => 0}
       end
-      alias :save :update
+      alias :update :rename
+
+      def configure(payload, options={})
+        self.attributes = rest_method("UPDATE", payload, options).attributes
+        self
+      end
 
       def destroy(force=false)
         debug "Deleting domain #{id}"

data/lib/rhc/rest/membership.rb

@@ -0,0 +1,105 @@
+module RHC::Rest
+  module Membership
+    class Member < Base
+      define_attr :name, :login, :id, :type, :from, :role, :owner, :explicit_role
+      def owner?
+        !!owner
+      end
+      def admin?
+        role == 'admin'
+      end
+      def editor?
+        role == 'edit'
+      end
+      def viewer?
+        role == 'view'
+      end
+      def name
+        attributes['name'] || login
+      end
+      def to_s
+        if name == login
+          "#{login} (#{role})"
+        elsif login
+          "#{name} <#{login}> (#{role})"
+        else
+          "#{name} (#{role})"
+        end
+      end
+      def role_weight
+        case role
+        when 'admin' then 0
+        when 'edit' then 1
+        when 'view' then 2
+        else 3
+        end
+      end
+    end
+
+    def self.included(other)
+    end
+
+    def supports_members?
+      supports? 'LIST_MEMBERS'
+    end
+
+    def supports_update_members?
+      supports? 'UPDATE_MEMBERS'
+    end
+
+    def members
+      @members ||=
+        if (members = attributes['members']).nil?
+          debug "Getting all members for #{id}"
+          raise RHC::MembersNotSupported unless supports_members?
+          rest_method 'LIST_MEMBERS'
+        else
+          members.map{ |m| Member.new(m, client) }
+        end
+    end
+
+    def compact_members
+      arr = members.reject(&:owner?) rescue []
+      if arr.length > 5
+        arr.sort_by!(&:name)
+        admin, arr = arr.partition(&:admin?)
+        edit, arr = arr.partition(&:editor?)
+        view, arr = arr.partition(&:viewer?)
+        admin << "Admins" if admin.present?
+        edit << "Editors" if edit.present?
+        view << "Viewers" if view.present?
+        arr.map!(&:to_s)
+        admin.concat(edit).concat(view).concat(arr)
+      elsif arr.present?
+        arr.sort_by{ |m| [m.role_weight, m.name] }.join(', ')
+      end
+    end
+
+    def update_members(members, options={})
+      raise "Members must be an array" unless members.is_a?(Array)
+      raise RHC::MembersNotSupported unless supports_members?
+      raise RHC::ChangeMembersOnResourceNotSupported unless supports_update_members?
+      @members = (attributes['members'] = rest_method('UPDATE_MEMBERS', {:members => members}, options))
+    end
+
+    def delete_members(options={})
+      raise RHC::MembersNotSupported unless supports_members?
+      rest_method "LIST_MEMBERS", nil, {:method => :delete}.merge(options)
+    ensure
+      @members = attributes['members'] = nil
+    end
+
+    def leave(options={})
+      raise RHC::MembersNotSupported unless supports? 'LEAVE'
+      rest_method "LEAVE", nil, options
+    ensure
+      @members = attributes['members'] = nil
+    end
+
+    def owner
+      if o = Array(attribute(:members)).find{ |m| m['owner'] == true }
+        o['name'] || o['login']
+      end
+    end
+  end
+end