rhc 1.23.7 → 1.24.4

data/lib/rhc/commands/team.rb

@@ -0,0 +1,103 @@
+require 'rhc/commands/base'
+
+module RHC::Commands
+  class Team < Base
+    summary "Create or delete a team"
+    syntax "<action>"
+    description <<-DESC
+      People who typically share the same role can be added to a team. The team can
+      then be added as a member of a domain, and all of the people in the team will
+      inherit the team's role on the domain.
+
+      If a person is a member of multiple teams which are members of a domain, or
+      is also added as a domain member individually, their effective role is the 
+      higher of their individual role or their teams' roles on the domain.
+
+      To create a team, run 'rhc create-team'.
+
+      To add members to an existing team, use the 'rhc add-member' command.
+
+      To list members of an existing team, use the 'rhc members' command.
+      DESC
+    default_action :help
+
+    summary "Create a new team"
+    syntax "<team_name>"
+    description <<-DESC
+      People who typically share the same role can be added to a team. The team can
+      then be added as a member of a domain, and all of the people in the team will
+      inherit the team's role on the domain.
+
+      If a person is a member of multiple teams which are members of a domain, or
+      is also added as a domain member individually, their effective role is the 
+      higher of their individual role or their teams' roles on the domain.
+      DESC
+    argument :team_name, "New team name (min 2 chars, max 250 chars)", ["-t", "--team-name NAME"]
+    def create(name)
+      say "Creating team '#{name}' ... "
+      rest_client.add_team(name)
+      success "done"
+
+      info "You may now add team members using the 'rhc add-member' command"
+
+      0
+    end
+
+    summary "Display a team and its members"
+    syntax "<team_name>"
+    takes_team :argument => true
+    def show(_)
+      team = find_team
+
+      display_team(team, true)
+
+      0
+    end
+
+    summary "Display all teams you are a member of"
+    option ['--mine'], "Display only teams you own"
+    alias_action :teams, :root_command => true
+    def list
+      teams = rest_client.send(options.mine ? :owned_teams : :teams, {:include => "members"})
+
+      teams.each do |t|
+        display_team(t, true)
+      end
+
+      if options.mine
+        success "You have #{pluralize(teams.length, 'team')}."
+      else
+        success "You are a member of #{pluralize(teams.length, 'team')}."
+      end
+
+      0
+    end
+
+    summary "Delete a team"
+    syntax "<team_name>"
+    takes_team :argument => true
+    def delete(_)
+      team = find_team(:owned => true)
+
+      say "Deleting team '#{team.name}' ... "
+      team.destroy
+      success "deleted"
+
+      0
+    end
+
+    summary "Leave a team (remove your membership)"
+    syntax "<team_name> [-t TEAM_NAME] [--team-id TEAM_ID]"
+    takes_team :argument => true
+    def leave(_)
+      team = find_team
+
+      say "Leaving team ... "
+      result = team.leave
+      success "done"
+      result.messages.each{ |s| paragraph{ say s } }
+
+      0
+    end
+  end
+end

data/lib/rhc/context_helper.rb

@@ -10,21 +10,43 @@ module RHC
 
     def self.included(other)
       other.module_eval do
+        def self.takes_team(opts={})
+          if opts[:argument]
+            argument :team_name, "Name of a team", ["-t", "--team-name NAME"], :allow_nil => true, :covered_by => :team_id
+          else
+            #:nocov:
+            option ["-t", "--team-name NAME"], "Name of a team", :covered_by => :team_id
+            #:nocov:
+          end
+          option ["--team-id ID"], "ID of a team", :covered_by => :team_name
+        end
+
         def self.takes_domain(opts={})
           if opts[:argument]
             argument :namespace, "Name of a domain", ["-n", "--namespace NAME"], :allow_nil => true, :default => :from_local_git
           else
+            #:nocov:
             option ["-n", "--namespace NAME"], "Name of a domain", :default => :from_local_git
+            #:nocov:
           end
         end
-        # Does not take defaults to avoid conflicts
-        def self.takes_application_or_domain(opts={})
-          option ["-n", "--namespace NAME"], "Name of a domain"
-          option ["-a", "--app NAME"], "Name of an application"
-          if opts[:argument]
-            argument :target, "The name of a domain, or an application name with domain (domain or domain/application)", ["-t", "--target NAME_OR_PATH"], :allow_nil => true, :covered_by => [:application_id, :namespace, :app]
+
+        def self.takes_membership_container(opts={})
+          if opts && opts[:argument]
+            if opts && opts[:writable]
+              #:nocov:
+              argument :namespace, "Name of a domain", ["-n", "--namespace NAME"], :allow_nil => true, :default => :from_local_git
+              #:nocov:
+            else
+              argument :target, "The name of a domain, or an application name with domain (domain or domain/application)", ["--target NAME_OR_PATH"], :allow_nil => true, :covered_by => [:application_id, :namespace, :app]
+            end
           end
+          option ["-n", "--namespace NAME"], "Name of a domain"
+          option ["-a", "--app NAME"], "Name of an application" unless opts && opts[:writable]
+          option ["-t", "--team-name NAME"], "Name of a team"
+          option ["--team-id ID"], "ID of a team"
         end
+
         def self.takes_application(opts={})
           if opts[:argument]
             argument :app, "Name of an application", ["-a", "--app NAME"], :allow_nil => true, :default => :from_local_git, :covered_by => :application_id
@@ -37,6 +59,18 @@ module RHC
       end
     end
 
+    def find_team(opts={})
+      if id = options.team_id.presence
+        return rest_client.find_team_by_id(id, opts)
+      end
+      team_name = (opts && opts[:team_name]) || options.team_name
+      if team_name.present?
+        rest_client.find_team(team_name, opts)
+      else
+        raise ArgumentError, "You must specify a team name with -t, or a team id with --team-id."
+      end
+    end
+
     def find_domain(opts={})
       domain = options.namespace || options.target || namespace_context
       if domain
@@ -46,7 +80,7 @@ module RHC
       end
     end
 
-    def find_app_or_domain(opts={})
+    def find_membership_container(opts={})
       domain, app =
         if options.target.present?
           options.target.split(/\//)
@@ -57,12 +91,19 @@ module RHC
             [options.namespace || namespace_context, options.app]
           end
         end
-      if app && domain
+
+      if options.team_id.present?
+        rest_client.find_team_by_id(options.team_id)
+      elsif options.team_name.present?
+        rest_client.find_team(options.team_name)
+      elsif app && domain
         rest_client.find_application(domain, app)
       elsif domain
         rest_client.find_domain(domain)
+      elsif opts && opts[:writable]
+        raise ArgumentError, "You must specify a domain with -n, or a team with -t."
       else
-        raise ArgumentError, "You must specify a domain with -n, or an application with -a."
+        raise ArgumentError, "You must specify a domain with -n, an application with -a, or a team with -t."
       end
     end
 

data/lib/rhc/exceptions.rb

@@ -214,13 +214,13 @@ module RHC
   end
 
   class ChangeMembersOnResourceNotSupported < Exception
-    def initialize(message="You can only add or remove members on a domain.")
+    def initialize(message="You can only add or remove members on a domain or team.")
       super message, 1
     end
   end
 
   class MembersNotSupported < Exception
-    def initialize(message="The server does not support adding or removing members.")
+    def initialize(message="The server does not support adding or removing members on this resource.")
       super message, 1
     end
   end

data/lib/rhc/output_helpers.rb

@@ -1,6 +1,24 @@
 module RHC
   module OutputHelpers
 
+    def display_team(team, ids=false)
+      paragraph do
+        header ["Team #{team.name}", ("(owned by #{team.owner})" if team.owner.present?)] do
+          section(:bottom => 1) do
+            say format_table \
+              nil,
+              get_properties(
+                team,
+                (:id if ids),
+                (:global if team.global?),
+                :compact_members
+              ),
+              :delete => true
+          end
+        end
+      end
+    end
+
     def display_domain(domain, applications=nil, ids=false)
       paragraph do
         header ["Domain #{domain.name}", ("(owned by #{domain.owner})" if domain.owner.present?)] do
@@ -144,7 +162,16 @@ module RHC
     end
 
     def format_usage_message(cart)
-      "This gear costs an additional $#{cart.usage_rate} per gear after the first 3 gears."
+      cart.usage_rates.map do |rate, plans|
+        plans = plans.map(&:capitalize) if plans
+        if plans && plans.length > 1
+          "This cartridge costs an additional $#{rate} per gear after the first 3 gears on the #{plans[0...-1].join(', ')} and #{plans[-1]} plans."
+        elsif plans && plans.length == 1
+          "This cartridge costs an additional $#{rate} per gear after the first 3 gears on the #{plans.first} plan."
+        else
+          "This cartridge costs an additional $#{rate} per gear after the first 3 gears."
+        end
+      end
     end
 
     def default_display_env_var(env_var_name, env_var_value=nil)

data/lib/rhc/rest/cartridge.rb

@@ -67,18 +67,22 @@ module RHC
       end
 
       def usage_rate?
-        rate = usage_rate
-        rate && rate > 0.0
-      end
-
-      def usage_rate
-        rate = attribute(:usage_rate_usd)
-
-        if attribute(:usage_rates)
-          rate ||= attribute(:usage_rates).inject(0) { |total, rate| total + rate['usd'].to_f }
+        rates = usage_rates
+        !(rates.nil? || rates.empty?)
+      end
+
+      def usage_rates
+        rate = attribute(:usage_rate_usd).to_f rescue 0.0
+        if rate > 0
+          {rate => []}
+        elsif attribute(:usage_rates).present?
+          attribute(:usage_rates).inject({}) do |plans_by_rate, rate|
+            if (usd = rate['usd'].to_f rescue 0.0) > 0
+              (plans_by_rate[usd] ||= []) << rate['plan_id']
+            end
+            plans_by_rate
+          end
         end
-
-        rate.to_f rescue 0.0
       end
 
       def scaling

data/lib/rhc/rest/client.rb

@@ -64,19 +64,30 @@ module RHC
         @user ||= api.rest_method "GET_USER"
       end
 
-      def teams
-        debug "Getting all teams"
+      def add_team(name, payload={})
+        debug "Adding team #{name} with options #{payload.inspect}"
+        @teams = nil
+        payload.delete_if{ |k,v| k.nil? or v.nil? }
+        if api.supports? 'ADD_TEAM'
+          api.rest_method "ADD_TEAM", {:name => name}.merge(payload)
+        else
+          raise RHC::TeamsNotSupportedException
+        end
+      end
+
+      def teams(opts={})
+        debug "Getting teams you are a member of"
         if link = api.link_href(:LIST_TEAMS)
-          @teams ||= api.rest_method "LIST_TEAMS"
+          @teams ||= api.rest_method("LIST_TEAMS", opts)
         else
           raise RHC::TeamsNotSupportedException
         end
       end
 
-      def owned_teams
+      def owned_teams(opts={})
         debug "Getting owned teams"
         if link = api.link_href(:LIST_TEAMS_BY_OWNER)
-          @owned_teams ||= api.rest_method "LIST_TEAMS_BY_OWNER", :owner => '@self'
+          @owned_teams ||= api.rest_method("LIST_TEAMS_BY_OWNER", opts.merge({:owner => '@self'}))
         else
           raise RHC::TeamsNotSupportedException
         end
@@ -96,6 +107,35 @@ module RHC
         owned_teams.select{|team| team.name.downcase =~ /#{Regexp.escape(search)}/i}
       end
 
+      def find_team(name, options={})
+        precheck_team_id(name)
+
+        matching_teams = if options[:global]
+          search_teams(name, true).select { |t| t.name == name }
+        elsif options[:owned]
+          owned_teams.select { |t| t.name == name }
+        else
+          teams.select{ |t| t.name == name }
+        end
+
+        if matching_teams.blank?
+          raise TeamNotFoundException.new("Team with name #{name} not found")
+        elsif matching_teams.length > 1
+          raise TeamNotFoundException.new("Multiple teams with name #{name} found. Use --team-id to select the team by id.")
+        else
+          matching_teams.first
+        end
+      end
+
+      def find_team_by_id(id, options={})
+        precheck_team_id(id)
+        if api.supports? :show_team
+          request(:url => link_show_team_by_id(id), :method => "GET", :payload => options)
+        else
+          teams.find{ |t| t.id == id }
+        end or raise TeamNotFoundException.new("Team with id #{id} not found")
+      end
+
       #Find Domain by namespace
       def find_domain(id)
         debug "Finding domain #{id}"
@@ -153,6 +193,11 @@ module RHC
         raise ApplicationNotFoundException.new("Application #{application} not found") if ['.','..'].include?(application)
       end
 
+      def precheck_team_id(team)
+        raise TeamNotFoundException.new("Team not specified") if team.blank?
+        raise TeamNotFoundException.new("Team #{team} not found") if ['.','..'].include?(team)
+      end
+
       def link_show_application_by_domain_name(domain, application, *args)
         [
           api.links['LIST_DOMAINS']['href'],
@@ -170,6 +215,10 @@ module RHC
         api.link_href(:SHOW_DOMAIN, ':id' => domain)
       end
 
+      def link_show_team_by_id(id, *args)
+        api.link_href(:SHOW_TEAM, {':id' => id}, *args)
+      end
+
       #Find Cartridge by name or regex
       def find_cartridges(name)
         debug "Finding cartridge #{name}"
@@ -276,7 +325,7 @@ module RHC
       # The list may not necessarily be sorted; we will select the last
       # matching one supported by the server.
       # See #api_version_negotiated
-      CLIENT_API_VERSIONS = [1.1, 1.2, 1.3, 1.4, 1.5, 1.6]
+      CLIENT_API_VERSIONS = [1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7]
       MAX_RETRIES = 5
 
       def initialize(*args)
@@ -582,6 +631,8 @@ module RHC
             data.map{ |json| EnvironmentVariable.new(json, self) }
           when 'deployments'
             data.map{ |json| Deployment.new(json, self) }
+          when 'team'
+            Team.new(data, self)
           when 'teams'
             data.map{ |json| Team.new(json, self) }
           when 'member'

data/lib/rhc/rest/membership.rb

@@ -88,6 +88,10 @@ module RHC::Rest
       supports? 'UPDATE_MEMBERS'
     end
 
+    def default_member_role
+      'edit'
+    end
+
     def members
       @members ||=
         if (members = attributes['members']).nil?
@@ -131,7 +135,7 @@ module RHC::Rest
     end
 
     def leave(options={})
-      raise RHC::MembersNotSupported unless supports? 'LEAVE'
+      raise RHC::MembersNotSupported.new("The server does not support leaving this resource.") unless supports? 'LEAVE'
       rest_method "LEAVE", nil, options
     ensure
       @members = attributes['members'] = nil

data/lib/rhc/rest/mock.rb

@@ -89,7 +89,7 @@ module RHC::Rest::Mock
         to_return({
           :body => {
             :data => mock_response_links(authorizations ? mock_api_with_authorizations : mock_real_client_links),
-            :supported_api_versions => [1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6],
+            :supported_api_versions => [1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7],
           }.to_json
         })
     end
@@ -421,10 +421,12 @@ module RHC::Rest::Mock
     end
 
     def mock_client_links
-      [['GET_USER',        'user/',       'get' ],
+      mock_teams_links.concat([
+       ['GET_USER',        'user/',       'get' ],
        ['ADD_DOMAIN',      'domains/add', 'post'],
        ['LIST_DOMAINS',    'domains/',    'get' ],
-       ['LIST_CARTRIDGES', 'cartridges/', 'get' ]]
+       ['LIST_CARTRIDGES', 'cartridges/', 'get' ]
+      ])
     end
 
     def mock_real_client_links
@@ -450,6 +452,15 @@ module RHC::Rest::Mock
       ])
     end
 
+    def mock_team_links(team_id='test_team')
+      [['GET',            "team/#{team_id}",          'get'    ],
+       ['ADD_MEMBER',     "team/#{team_id}/members/", 'post', {'optional_params' => [{'name' => 'id'}, {'name' => 'login'}], 'required_params' => [{'name' => 'role'}]} ],
+       ['LIST_MEMBERS',   "team/#{team_id}/update",   'get'    ],
+       ['UPDATE_MEMBERS', "team/#{team_id}/delete",   'patch', {'optional_params' => [{'name' => 'id'}, {'name' => 'login'}, {'name' => 'members'}] } ],
+       ['LEAVE',          "team/#{team_id}/delete",   'delete' ],
+       ['DELETE',         "team/#{team_id}/delete",   'delete' ]]
+    end
+
     def mock_domain_links(domain_id='test_domain')
       [['ADD_APPLICATION',   "domains/#{domain_id}/apps/add", 'post', {'optional_params' => [{'name' => 'environment_variables'}, {'name' => 'cartridges[][name]'}, {'name' => 'cartridges[][url]'}]} ],
        ['LIST_APPLICATIONS', "domains/#{domain_id}/apps/",    'get' ],
@@ -540,6 +551,7 @@ module RHC::Rest::Mock
         end
       end
       @domains = []
+      @teams = []
       @user = MockRestUser.new(self, config.username)
       @api = MockRestApi.new(self, config)
       @version = version
@@ -557,13 +569,17 @@ module RHC::Rest::Mock
       @domains
     end
 
+    def teams(opts={})
+      @teams
+    end
+
     def api_version_negotiated
       @version
     end
 
     def cartridges
       premium_embedded = MockRestCartridge.new(self, "premium_cart", "embedded")
-      premium_embedded.usage_rate = 0.05
+      premium_embedded.usage_rates = {0.05 => []}
 
       [MockRestCartridge.new(self, "mock_cart-1", "embedded"), # code should sort this to be after standalone
        MockRestCartridge.new(self, "mock_standalone_cart-1", "standalone"),
@@ -579,6 +595,15 @@ module RHC::Rest::Mock
       ]
     end
 
+    def add_team(name, extra=false)
+      t = MockRestTeam.new(self, name)
+      if extra
+        t.attributes['members'] = [{'owner' => true, 'name' => 'a_user_name'}]
+      end
+      @teams << t
+      t
+    end
+
     def add_domain(id, extra=false)
       d = MockRestDomain.new(self, id)
       if extra
@@ -662,6 +687,35 @@ module RHC::Rest::Mock
     end
   end
 
+  class MockRestTeam < RHC::Rest::Team
+    include Helpers
+    def initialize(client, name, id="123")
+      super({}, client)
+      @id = id
+      @name = name
+      @members = []
+      self.attributes = {:links => mock_response_links(mock_team_links(id))}
+    end
+
+    def destroy
+      raise RHC::OperationNotSupportedException.new("The server does not support deleting this resource.") unless supports? 'DELETE'
+      client.teams.delete_if { |t| t.name == @name }
+    end
+
+    def init_members
+      @members ||= []
+      attributes['members'] ||= []
+      self
+    end
+
+    def add_member(member)
+      (@members ||= []) << member
+      (attributes['members'] ||= []) << member.attributes
+      self
+    end
+
+  end
+
   class MockRestDomain < RHC::Rest::Domain
     include Helpers
     def initialize(client, id)
@@ -792,7 +846,7 @@ module RHC::Rest::Mock
       self.attributes = {:links => mock_response_links(mock_app_links('mock_domain_0', 'mock_app_0')), :messages => []}
       self.gear_count = 5
       types = Array(type)
-      cart = add_cartridge(types.first, false) if types.first
+      cart = add_cartridge(types.first, true) if types.first
       if scale
         cart.supported_scales_to = (cart.scales_to = -1)
         cart.supported_scales_from = (cart.scales_from = 2)
@@ -800,6 +854,7 @@ module RHC::Rest::Mock
         cart.scales_with = "haproxy-1.4"
         prox = add_cartridge('haproxy-1.4')
         prox.collocated_with = [types.first]
+        prox.tags = ['web_proxy']
       end
       types.drop(1).each{ |c| add_cartridge(c, false) }
       @framework = types.first
@@ -959,7 +1014,7 @@ module RHC::Rest::Mock
   class MockRestCartridge < RHC::Rest::Cartridge
     include Helpers
 
-    attr_accessor :usage_rate
+    attr_accessor :usage_rates
 
     def initialize(client, name, type, app=nil, tags=[], properties=[{'type' => 'cart_data', 'name' => 'connection_url', 'value' => "http://fake.url" }], description=nil)
       super({}, client)
@@ -975,7 +1030,7 @@ module RHC::Rest::Mock
       @current_scale = 1
       @gear_profile = 'small'
       @additional_gear_storage = 5
-      @usage_rate = 0.0
+      @usage_rates = {}
     end
 
     def destroy