pbox 1.17.2

data/lib/rhc/commands/deployment.rb

@@ -0,0 +1,82 @@
+require 'rhc/commands/base'
+require 'rhc/deployment_helpers'
+
+module RHC::Commands
+  class Deployment < Base
+    include RHC::DeploymentHelpers
+
+    summary "Commands for deploying and managing deployments of an application"
+    description <<-DESC
+      By default ProtonBox applications prepare, distribute, and activate deployments
+      on every git push. Alternatively, a user may choose to disable automatic
+      deployments and use this 'pbox deployment' set of commands to fully control the
+      deployment lifecycle. Use these commands to deploy manually from a git reference
+      or from a binary file, list and display deployments and also activate existing
+      deployments. Check also 'pbox configure-app' to configure your application to
+      deploy manually.
+
+      DESC
+    syntax "<action>"
+    default_action :help
+
+    summary "List the existing deployments of an application"
+    description <<-DESC
+      List all existing deployments of a given application. Check the 'pbox configure-app'
+      command to configure how many deployments are preserved in history.
+
+      DESC
+    syntax "<application>"
+    takes_application :argument => true
+    alias_action :"deployments", :root_command => true
+    def list(app)
+      rest_app = find_app
+      deployment_activations = rest_app.deployment_activations
+
+      raise RHC::DeploymentNotFoundException, "No deployments found for application #{app}." if !deployment_activations.present?
+
+      pager
+
+      display_deployment_list(deployment_activations)
+      0
+    end
+
+    summary "Show details of the given deployment"
+    syntax "<deployment_id> --app NAME [--namespace NAME]"
+    description <<-DESC
+      Display details of the given deployment id.
+
+      DESC
+    takes_application
+    argument :id, "The deployment ID to show", ["--id ID"], :optional => false
+    def show(id)
+      rest_app = find_app
+      item = rest_app.deployment_activations.reverse_each.detect{|item| item[:deployment].id == id}
+
+      raise RHC::DeploymentNotFoundException, "Deployment ID '#{id}' not found for application #{rest_app.name}." if !item.present?
+
+      display_deployment(item)
+      paragraph { say "Use 'pbox show-app #{rest_app.name} --configuration' to check your deployment configurations." }
+      0
+    end
+
+    summary "Activate an existing deployment"
+    description <<-DESC
+      Switch between existing deployments. This command allows you to rollback from one
+      deployment to a previous one or activate subsequent deployments. Check the 'pbox
+      configure-app' command to configure how many deployments are preserved in history.
+
+      DESC
+    syntax "<deployment_id> --app NAME [--namespace NAME]"
+    takes_application
+    argument :id, "The deployment ID to activate on the application", ["--id ID"], :optional => false
+    def activate(id)
+      rest_app = find_app
+
+      raise RHC::DeploymentsNotSupportedException.new if !rest_app.supports? "DEPLOY"
+
+      activate_deployment(rest_app, id)
+      0
+    end
+
+  end
+end

data/lib/rhc/commands/domain.rb

@@ -0,0 +1,167 @@
+require 'rhc/commands/base'
+
+module RHC::Commands
+  class Domain < Base
+    summary "Add or rename the container for your apps"
+    syntax "<action>"
+    description <<-DESC
+      All ProtonBox applications must belong to a domain.  The name of the domain
+      will be used as part of the public URL for an application.
+
+      For example, when creating a domain with the name "test", any applications
+      created in that domain will have the public URL:
+
+        http://<appname>-test.protonbox.me
+
+      Each account may have access to one or more domains shared by others.  Depending
+      on your plan or configuration, you may be able to create more than one domain.
+
+      To create your first domain, run 'pbox setup' or 'pbox create-domain'.
+      DESC
+    default_action :help
+
+    summary "Create a new container for applications."
+    syntax "<namespace>"
+    description <<-DESC
+      A domain is a container for your applications. Each account may have one
+      or more domains (depending on plan), and you may collaborate on applications
+      by adding members to your domain.
+
+      The name of the domain is called its "namespace", and becomes part of the
+      application public URLs. For example, when creating a domain with the name "test",
+      all applications in that domain will have the public URL:
+
+        http://<appname>-test.protonbox.me
+
+      The domain owner may limit the gear sizes available to applications by using the
+      '--allowed-gear-sizes' option.  If '--no-allowed-gear-sizes' is set, no applications
+      can be created in the domain.  Older servers may not support this option.
+      DESC
+    option ['--[no-]allowed-gear-sizes [SIZES]'], 'A comma-delimited list of the gear sizes that will be allowed in this domain.', :optional => true
+    argument :namespace, "New domain name (letters and numbers, max 16 chars)", ["-n", "--namespace NAME"]
+    def create(namespace)
+      say "Creating domain '#{namespace}' ... "
+      rest_client.add_domain(namespace, :allowed_gear_sizes => check_allowed_gear_sizes)
+      success "done"
+
+      info "You may now create an application using the 'pbox create-app' command"
+
+      0
+    end
+
+    summary "Rename a domain (will change application urls)"
+    syntax "<old name> <new name>"
+    argument :old_namespace, "Existing domain name", []
+    argument :new_namespace, "New domain name (letters and numbers, max 16 chars)", ["-n", "--namespace NAME"]
+    alias_action :update, :deprecated => true
+    def rename(old_namespace, new_namespace)
+      domain = rest_client.find_domain(old_namespace)
+
+      say "Renaming domain '#{domain.name}' to '#{new_namespace}' ... "
+      domain.rename(new_namespace)
+      success "done"
+
+      info "Applications in this domain will use the new name in their URL."
+
+      0
+    end
+
+    summary "Change one or more configuration settings on the domain"
+    syntax "<namespace>"
+    option ['--[no-]allowed-gear-sizes [SIZES]'], 'A comma-delimited list of the gear sizes that will be allowed in this domain.', :optional => true
+    takes_domain :argument => true
+    def configure(_)
+      domain = find_domain
+      payload = {}
+      payload[:allowed_gear_sizes] = check_allowed_gear_sizes unless options.allowed_gear_sizes.nil?
+
+      if payload.present?
+        say "Updating domain configuration ... "
+        domain.configure(payload)
+        success "done"
+      end
+
+      paragraph do
+        say format_table("Domain #{domain.name} configuration", get_properties(domain, :allowed_gear_sizes), :delete => true)
+      end
+
+      0
+    end
+
+    summary "Display a domain and its applications"
+    takes_domain :argument => true
+    def show(_)
+      domain = find_domain
+
+      warn "In order to deploy applications, you must create a domain with 'pbox setup' or 'pbox create-domain'." and return 1 unless domain
+
+      applications = domain.applications(:include => :cartridges)
+      display_domain(domain, applications)
+
+      if applications.present?
+        success "You have #{pluralize(applications.length, 'application')} in your domain."
+      else
+        success "The domain #{domain.name} exists but has no applications. You can use 'pbox create-app' to create a new application."
+      end
+
+      0
+    end
+
+    summary "Display all domains you have access to"
+    option ['--mine'], "Display only domains you own"
+    option ['--ids'], "Display the unique id of the domain (not supported by all servers)"
+    alias_action :domains, :root_command => true
+    def list
+      domains = rest_client.send(options.mine ? :owned_domains : :domains)
+
+      warn "In order to deploy applications, you must create a domain with 'pbox setup' or 'pbox create-domain'." and return 1 unless domains.present?
+
+      domains.each do |d|
+        display_domain(d, nil, options.ids)
+      end
+
+      success "You have access to #{pluralize(domains.length, 'domain')}."
+
+      0
+    end
+
+    summary "Delete a domain"
+    syntax "<namespace>"
+    takes_domain :argument => true
+    def delete(_)
+      domain = find_domain
+
+      say "Deleting domain '#{domain.name}' ... "
+      domain.destroy
+      success "deleted"
+
+      0
+    end
+
+    summary "Leave a domain (remove your membership)"
+    syntax "<namespace>"
+    argument :namespace, "Name of the domain", ["-n", "--namespace NAME"]
+    def leave(namespace)
+      domain = rest_client.find_domain(namespace)
+
+      say "Leaving domain ... "
+      domain.leave
+      success "done"
+
+      0
+    end
+
+    protected
+      def check_allowed_gear_sizes
+        sizes = options.allowed_gear_sizes
+        raise OptionParser::InvalidOption, "The server does not support --allowed-gear-sizes" unless sizes.nil? || rest_client.api.has_param?(:add_domain, 'allowed_gear_sizes')
+        if sizes.is_a? String
+          sizes.split(',').map(&:strip).map(&:presence)
+        elsif sizes == false
+          []
+        elsif sizes
+          raise OptionParser::InvalidOption, "Provide a comma delimited list of valid gear sizes to --allowed-gear-sizes"
+        end
+      end
+  end
+end

data/lib/rhc/commands/env.rb

@@ -0,0 +1,142 @@
+require 'rhc/commands/base'
+
+module RHC::Commands
+  class Env < Base
+    summary "Manages user-defined environment variables set on a given application"
+    syntax "<action>"
+    description <<-DESC
+      Manages the user-defined environment variables set on a given
+      application. To see a list of all environment variables use the command
+      'pbox list-env <application>'. Note that some predefined
+      cartridge-level environment variables can also be overriden,
+      but most variables provided by gears are read-only.
+
+      Type 'pbox set-env --help' for more details.
+
+      DESC
+    default_action :help
+    alias_action :"app env", :root_command => true
+
+    summary "Set one or more environment variable(s) to your application"
+    description <<-DESC
+      Set one or more environment variable(s) to your application.
+      Operands of the form 'VARIABLE=VALUE' set the environment
+      variable VARIABLE to value VALUE. Example:
+
+      pbox set-env VARIABLE1=VALUE1 VARIABLE2=VALUE2 -a myapp
+
+      Environment variables can also be set from a file containing one
+      or more VARIABLE=VALUE pairs (one per line). Example:
+
+      pbox set-env /path/to/file -a myapp
+
+      VALUE may be empty, in that case 'VARIABLE='. Setting a
+      variable to an empty value is different from unsetting it.
+
+      Some default cartridge-level variables can be overriden, but
+      variables provided by gears are read-only.
+
+      DESC
+    syntax "<VARIABLE=VALUE> [... <VARIABLE=VALUE>] [--namespace NAME] [--app NAME]"
+    argument :env, "Environment variable name and value pair separated by an equal (=) sign, e.g. VARIABLE=VALUE", ["-e", "--env VARIABLE=VALUE"], :optional => false, :type => :list
+    takes_application
+    option ["--confirm"], "Pass to confirm setting the environment variable(s)"
+    alias_action :add
+    def set(env)
+      rest_app = find_app
+
+      with_file = env.index {|item| File.file? item}
+
+      env_vars = []
+      env.each {|item| env_vars.concat(collect_env_vars(item))}
+      raise RHC::EnvironmentVariableNotProvidedException.new(
+        (with_file ?
+          "Environment variable(s) not found in the provided file(s).\n" :
+          "Environment variable(s) not provided.\n") <<
+          "Please provide at least one environment variable using the syntax VARIABLE=VALUE. VARIABLE can only contain letters, digits and underscore ('_') and can't begin with a digit.") if env_vars.empty?
+
+      if with_file
+        env_vars.each {|item| default_display_env_var(item.name, item.value)}
+        confirm_action "Do you want to set these environment variables on '#{rest_app.name}?"
+      end
+
+      say 'Setting environment variable(s) ... '
+      rest_app.set_environment_variables(env_vars)
+      success 'done'
+
+      0
+    end
+
+    summary "Remove one or more environment variable(s) currently set to your application"
+    description <<-DESC
+      Remove one or more environment variable(s) currently set to your
+      application. Setting a variable to an empty value is
+      different from unsetting it. When unsetting a default cartridge-
+      level variable previously overriden, the variable will be set
+      back to its default value.
+
+      DESC
+    syntax "<VARIABLE> [... <VARIABLE>] [--namespace NAME] [--app NAME]"
+    argument :env, "Name of the environment variable(s), e.g. VARIABLE", ["-e", "--env VARIABLE"], :optional => false, :type => :list
+    takes_application
+    option ["--confirm"], "Pass to confirm removing the environment variable"
+    alias_action :remove
+    def unset(env)
+      rest_app = find_app
+
+      warn 'Removing environment variables is a destructive operation that may result in loss of data.'
+
+      env.each do |e|
+        default_display_env_var(e)
+      end
+
+      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'
+
+      0
+    end
+
+    summary "List all environment variables set on the application"
+    description <<-DESC
+      List all user-defined environment variables set on the application.
+      Gear-level variables overriden by the 'pbox set-env' command
+      will also be listed.
+
+      DESC
+    syntax "<app> [--namespace NAME]"
+    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"
+    def list(app)
+      rest_app = find_app
+      rest_env_vars = rest_app.environment_variables
+
+      pager
+
+      display_env_var_list(rest_env_vars, { :table => options.table, :quotes => options.quotes })
+
+      0
+    end
+
+    summary "Show the value of one or more environment variable(s) currently set to your application"
+    syntax "<VARIABLE> [... <VARIABLE>] [--namespace NAME] [--app NAME]"
+    argument :env, "Name of the environment variable(s), e.g. VARIABLE", ["-e", "--env VARIABLE"], :optional => false, :type => :list
+    takes_application
+    option ["--table"], "Format the output list as a table"
+    option ["--quotes"], "Format the output list with double quotes for env var values"
+    def show(env)
+      rest_app = find_app
+      rest_env_vars = rest_app.find_environment_variables(env)
+
+      pager
+
+      display_env_var_list(rest_env_vars, { :table => options.table, :quotes => options.quotes })
+
+      0
+    end
+
+  end
+
+end

data/lib/rhc/commands/git_clone.rb

@@ -0,0 +1,29 @@
+require 'rhc/commands/base'
+require 'rhc/git_helpers'
+
+module RHC::Commands
+  class GitClone < Base
+    summary "Clone and configure an application's repository locally"
+    description "This is a convenience wrapper for 'git clone' with the added",
+                "benefit of adding configuration data such as the application's",
+                "UUID to the local repository.  It also automatically",
+                "figures out the Git url from the application name so you don't",
+                "have to look it up."
+    syntax "<app> [--namespace NAME]"
+    takes_application :argument => true
+    option ["-r", "--repo dir"], "Path to the Git repository (defaults to ./$app_name)"
+    alias_action 'app git-clone', :deprecated => true, :root_command => true
+    # TODO: Implement default values for arguments once ffranz has added context arguments
+    # argument :directory, "The name of a new directory to clone into", [], :default => nil
+    def run(app_name)
+      rest_app = find_app
+      dir = git_clone_application(rest_app)
+      success "Your application Git repository has been cloned to '#{system_path(dir)}'"
+
+      0
+    end
+
+    private
+      include RHC::GitHelpers
+  end
+end

data/lib/rhc/commands/logout.rb

@@ -0,0 +1,51 @@
+module RHC::Commands
+  class Logout < Base
+    suppress_wizard
+
+    summary "End the current session"
+    description <<-DESC
+      Logout ends your current session on the server and then removes
+      all of the local session files.  If you are using multiple 
+      servers and configurations this will remove all of your local
+      session files.
+
+      The --all option will terminate all authorizations on your
+      account. Any previously generated authorizations will be
+      deleted and external tools that integrate with your account
+      will no longer be able to log in.
+      DESC
+    option '--all', "Remove all authorizations on your account."
+    alias_action 'account logout', :root_command => true
+    def run
+      if options.all
+        rest_client.user # force authentication
+        say "Deleting all authorizations associated with your account ... "
+        begin
+          rest_client.delete_authorizations
+          success "done"
+        rescue RHC::Rest::AuthorizationsNotSupported
+          info "not supported"
+        end
+      elsif token_for_user
+        options.noprompt = true
+        say "Ending session on server ... "
+        begin
+          rest_client.delete_authorization(token_for_user)
+          success "deleted"
+        rescue RHC::Rest::AuthorizationsNotSupported
+          info "not supported"
+        rescue RHC::Rest::TokenExpiredOrInvalid
+          info "already closed"
+        rescue => e
+          debug_error(e)
+          warn e.message
+        end
+      end
+
+      0
+    ensure
+      token_store.clear
+      success "All local sessions removed."
+    end
+  end
+end

data/lib/rhc/commands/member.rb

@@ -0,0 +1,148 @@
+require 'rhc/commands/base'
+
+module RHC::Commands
+  class Member < Base
+    summary "Manage membership on domains"
+    syntax "<action>"
+    description <<-DESC
+      Teams of developers can collaborate on applications by adding people to
+      domains as members: each member has a role (admin, editor, or viewer),
+      and those roles determine what the user can do with the domain and the
+      applications contained within.
+
+      Roles:
+
+        view  - able to see information about the domain and its apps, but not make any changes
+        edit  - create, update, and delete applications, and has Git and SSH access
+        admin - can update membership of a domain
+
+      The default role granted to members when added is 'edit' - use the '--role'
+      argument to use another.  When adding and removing members, you can use their
+      'login' value (typically their email or a short unique name for them) or their
+      'id'.  Both login and ID are visible via the 'pbox account' command.
+
+      To see existing members of a domain or application, use:
+
+        pbox members -n <domain_name> [-a <app_name>]
+
+      To change the role for a user, simply call the add-member command with the new role. You
+      cannot change the role of the owner.
+      DESC
+    syntax "<action>"
+    default_action :help
+
+    summary "List members of a domain or application"
+    syntax "<domain_or_app_name> [-n DOMAIN_NAME] [-a APP_NAME]"
+    description <<-DESC
+      Show the existing members of a domain or application - you can pass the name
+      of your domain with '-n', the name of your application with '-a', or combine
+      them in the first argument to the command like:
+
+        pbox members <domain_name>/[<app_name>]
+
+      The owner is always listed first.  To see the unique ID of members, pass
+      '--ids'.
+      DESC
+    option ['--ids'], "Display the IDs of each member", :optional => true
+    takes_application_or_domain :argument => true
+    alias_action :members, :root_command => true
+    def list(path)
+      target = find_app_or_domain(path)
+      members = target.members.sort_by{ |m| [m.owner? ? 0 : 1, m.role_weight, m.name] }
+      show_name = members.any?{ |m| m.name && m.name != m.login }
+      members.map! do |m|
+        [
+          ((m.name || "") if show_name),
+          m.login || "",
+          m.owner? ? "#{m.role} (owner)" : m.role,
+          (m.id if options.ids)
+        ].compact
+      end
+      say table(members, :header => [('Name' if show_name), 'Login', 'Role', ("ID" if options.ids)].compact)
+
+      0
+    end
+
+    summary "Add or update a member on a domain"
+    syntax "<login> [<login>...] [-n DOMAIN_NAME] [--role view|edit|admin] [--ids]"
+    description <<-DESC
+      Adds or updates members on a domain by passing one or more login
+      or ids for other people on ProtonBox.  The login and ID values for each
+      account are displayed in 'pbox account'. To change the role for a user, simply
+      call the add-member command with the new role. You cannot change the role of
+      the owner.
+
+      Roles
+        view  - able to see information about the domain and its apps,
+                but not make any changes
+        edit  - create, update, and delete applications, and has Git
+                and SSH access
+        admin - can update membership of a domain
+
+      The default role granted to members when added is 'edit' - use the '--role'
+      argument for 'view' or 'admin'.
+
+      Examples
+        pbox add-member sally joe -n mydomain
+          Gives the accounts with logins 'sally' and 'joe' edit access on mydomain
+
+        pbox add-member bob@example.com --role admin -n mydomain
+          Gives the account with login 'bob@example.com' admin access on mydomain
+
+      DESC
+    takes_domain
+    option ['--ids'], "Treat the arguments as a list of IDs", :optional => true
+    option ['-r', '--role ROLE'], "The role to give to each member - view, edit, or admin (default 'edit')", :type => Role, :optional => true
+    argument :members, "A list of members logins to add.  Pass --ids to treat this as a list of IDs.", [], :type => :list
+    def add(members)
+      target = find_domain
+      role = options.role || 'edit'
+      raise ArgumentError, 'You must pass one or more logins or ids to this command' unless members.present?
+      say "Adding #{pluralize(members.length, role_name(role))} to #{target.class.model_name.downcase} ... "
+      target.update_members(changes_for(members, role))
+      success "done"
+
+      0
+    end
+
+    summary "Remove a member from a domain"
+    syntax "<login> [<login>...] [-n DOMAIN_NAME] [--ids]"
+    description <<-DESC
+      Remove members on a domain by passing one or more login or ids for each
+      member you wish to remove.  View the list of existing members with
+      'pbox members <domain_name>'.
+
+      Pass '--all' to remove all but the owner from the domain.
+      DESC
+    takes_domain
+    option ['--ids'], "Treat the arguments as a list of IDs"
+    option ['--all'], "Remove all members from this domain."
+    argument :members, "Member logins to remove from the domain.  Pass --ids to treat this as a list of IDs.", [], :type => :list
+    def remove(members)
+      target = find_domain
+
+      if options.all
+        say "Removing all members from #{target.class.model_name.downcase} ... "
+        target.delete_members
+        success "done"
+
+      else
+        raise ArgumentError, 'You must pass one or more logins or ids to this command' unless members.present?
+        say "Removing #{pluralize(members.length, 'member')} from #{target.class.model_name.downcase} ... "
+        target.update_members(changes_for(members, 'none'))
+        success "done"
+      end
+
+      0
+    end
+
+    protected
+      def changes_for(members, role)
+        members.map do |m|
+          h = {:role => role}
+          h[options.ids ? :id : :login] = m
+          h
+        end
+      end
+  end
+end