rightscale-cli 0.5.6 → 0.6.0

data/lib/rightscale_cli.rb

@@ -17,5 +17,4 @@
 require 'rightscale_cli/version'
 require 'rightscale_cli/config'
 require 'rightscale_cli/monkey_patches/client_attributes'
-#require 'rightscale_cli/logger'
 require 'rightscale_cli/rightscale_cli'

data/lib/rightscale_cli/client.rb

@@ -20,55 +20,65 @@ require 'rightscale_cli/logger'
 require 'ask_pass'
 
 class RightScaleCLI
+  # Represents a RightScale CLI Client
   class Client
     attr_accessor :client
     attr_accessor :render
-    
+
     def initialize(options)
       config = RightScaleCLI::Config.new.directives
       config[:account_id] = options['account'] if options[:account]
       config[:email] = options['user'] if options[:user]
       config[:api_version] = options['api'] if options[:api]
+      config[:timeout] = nil
 
-      if options['password'] || (!config[:password] && !config[:password_base64])
+      if options['password'] || \
+         (!config[:password] && \
+          !config[:password_base64] &&
+          !config[:access_token])
+        # fallback to asking for user password
         config[:password] = ask_pass
-        config[:password_base64] = nil    # set this to nil so it is not used by precedence
+        # set this to nil so it is not used by precedence
+        config[:password_base64] = nil
       end
 
       @options = options
       @client = RightApi::Client.new(config)
-      @logger = RightScaleCLI::Logger.new()
+      @logger = RightScaleCLI::Logger.new
     end
 
     def get(resource)
       result = []
-      @client.send(resource).index.each { |record|
-        result.push(record.raw)
-      }
-      return result
+      @client.send(resource).index.each { |record| result.push(record.raw) }
+      result
     end
 
     def show(resource, resource_id, *args)
       if args.count > 0
         result = []
-        records = @client.send(resource).index({ :id => resource_id }).show.send(args[0]).index
-        records.each { |record|
-          result.push(record.raw)
-        }
+        records = @client.send(resource).index(id: resource_id)
+                  .show.send(args[0]).index
+        records.each { |record| result.push(record.raw) }
         @logger.info("Resource count: #{result.count}.")
       else
-        result = @client.send(resource).index({ :id => resource_id }).show.raw
+        result = @client.send(resource).index(id: resource_id).show.raw
       end
-      return result 
+      result
     end
 
     def create(resource, params)
-      resource = @client.send("#{resource}s").create(resource => params)
+      if params[:cloud]
+        resource = @client.clouds(id: params[:cloud]).show.send("#{resource}s")
+                   .create(params)
+      else
+        resource = @client.send("#{resource}s").create(params)
+      end
       @logger.info("Created #{resource.href}.")
+      resource.href
     end
 
     def destroy(resource, resource_id)
-      resource = @client.send("#{resource}s").index({ :id => resource_id })
+      resource = @client.send("#{resource}s").index(id: resource_id)
       resource.destroy
       @logger.info("Deleted #{resource.href}.")
     end

data/lib/rightscale_cli/clouds.rb

@@ -19,66 +19,66 @@ require 'rightscale_cli/client'
 require 'rightscale_cli/logger'
 
 class RightScaleCLI
+  # Represents Clouds
   class Clouds < Thor
     namespace :clouds
 
     def initialize(*args)
       super
       @client = RightScaleCLI::Client.new(options)
-      @logger = RightScaleCLI::Logger.new()
+      @logger = RightScaleCLI::Logger.new
     end
 
     # include render options
     eval(IO.read("#{File.dirname(File.expand_path(__FILE__))}/render_options.rb"), binding)
 
-    desc "list", "Lists all clouds."
-    option :basic, :type => :boolean, :required => false
-    def list()
+    desc 'list', 'lists all clouds connected to the account'
+    option :basic, type: :boolean, required: false
+    def list
       clouds = @client.get('clouds')
 
       if options[:basic]
-        basic_fields = [ 'display_name', 'cloud_type', 'name' ]
+        basic_fields = %w('display_name', 'cloud_type', 'name')
         basic_clouds = []
-        @client.get('clouds').each { |cloud|
-          cloud_id = cloud['links'].select { |link| link['rel'] == 'instances' }.first['href'].split('/')[3]
-          c = cloud.select{|x| basic_fields.include?(x)}
+        @client.get('clouds').each do |cloud|
+          cloud_id = cloud['links'].select { |link| link['rel'] == 'instances' }
+                     .first['href'].split('/')[3]
+          c = cloud.select { |x| basic_fields.include?(x) }
           c['cloud_id'] = cloud_id.to_i
           basic_clouds.push(c)
-        }
+        end
         clouds = basic_clouds
       end
 
       @client.render(clouds, 'clouds')
     end
 
-    desc "show", "Shows a cloud."
+    desc 'show', 'shows a cloud'
     def show(cloud_id)
       @client.render(@client.show('clouds', cloud_id), 'cloud')
     end
 
-    desc "search", "Searches for clouds by cloud type, name, description."
-    option :name, :type => :string, :required => false
-    option :cloud_type, :type => :string, :required => false
-    option :description, :type => :string, :required => false
-    def search()
+    desc 'search', 'searches for clouds by cloud type, name, description'
+    option :name, type: :string, required: false
+    option :cloud_type, type: :string, required: false
+    option :description, type: :string, required: false
+    def search
       filter = []
       filter.push("name==#{options[:name]}") if options[:name]
       filter.push("cloud_type==#{options[:cloud_type]}") if options[:cloud_type]
       filter.push("description==#{options[:cloud]}") if options[:description]
 
-      @logger.info "Searching for clouds!"
+      @logger.info 'Searching for clouds!'
 
       puts "filter: #{filter}" if options[:debug]
-      
-      clouds = []
-      @client.client.clouds.index(:filter => filter).each { |cloud|
-        clouds.push(cloud.raw)
-      }  
 
+      clouds = []
+      @client.client.clouds.index(filter: filter)
+        .each { |cloud| clouds.push(cloud.raw) }
       @client.render(clouds, 'clouds')
     end
 
-    def self.banner(task, namespace = true, subcommand = false)
+    def self.banner(task, _namespace = true, subcommand = false)
       "#{basename} #{task.formatted_usage(self, true, subcommand)}"
     end
   end

data/lib/rightscale_cli/config.rb

@@ -1,5 +1,5 @@
 # Author:: Chris Fordham (<chris@fordham-nagy.id.au>)
-# Copyright:: Copyright (c) 2013 Chris Fordham
+# Copyright:: Copyright (c) 2013-2105 Chris Fordham
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,27 +18,32 @@ require 'yaml'
 require 'fileutils'
 
 class RightScaleCLI
+  # Represents a RightScale CLI configuration
   class Config
     attr_accessor :template_path, :config_home, :config_path, :directives
 
-    def initialize(*args)
-      @template_path = File.join(File.dirname(__FILE__), '..', 'templates', 'right_api_client.yml.erb')
+    def initialize(*)
+      @template_path = File.join(File.dirname(__FILE__),
+                                 '..', 'templates', 'right_api_client.yml.erb')
       @config_home = File.join(ENV['HOME'], '.rightscale')
       @config_path = File.join(@config_home, 'right_api_client.yml')
 
-      Dir.mkdir(@config_home) unless File.exists?(@config_home)
+      Dir.mkdir(@config_home) unless File.exist?(@config_home)
       FileUtils.touch(@config_path)
-      
+
       # write a fresh file if it does not load/parse
       unless YAML.load_file(@config_path)
         @directives = {
-           :account_id => '',
-           :email => '',
-           :password_base64 => '',
-           :api_url => 'https://us-4.rightscale.com',
-           :api_version => '1.5'
+          account_id: '',
+          email: nil,
+          password_base64: '',
+          access_token: '',
+          api_url: 'https://us-4.rightscale.com',
+          api_version: '1.5'
         }
-        File.open(@config_path, 'w') {|f| f.write(ERB.new(IO.read(@template_path)).result(binding)) }
+        File.open(@config_path, 'w') do |f|
+          f.write(ERB.new(IO.read(@template_path)).result(binding))
+        end
       end
 
       # load/reload the directives from the file

data/lib/rightscale_cli/configure.rb

@@ -20,6 +20,7 @@ require 'rightscale_cli/config'
 require 'rightscale_cli/logger'
 require 'rightscale_cli/client'
 require 'ask_pass'
+require 'yesno'
 require 'erb'
 require "base64"
 
@@ -58,6 +59,18 @@ class RightScaleCLI
       update_conf
     end
 
+    desc "oauth", "Configure the RightScale OAuth access token for the client."
+    def oauth()
+      @directives.merge!( { :access_token => ask("RightScale API access token:") })
+      update_conf
+    end
+
+    desc 'refresh', 'configure the RightScale refresh token for the client'
+    def refresh()
+      @directives.merge!( { :refresh_token => ask('RightScale API refresh token:') })
+      update_conf
+    end
+
     desc "api", "Configure the RightScale API version used by the client."
     def api()
       @directives.merge!( { :api_version => ask("RightScale API version (e.g. 1.5):") })
@@ -66,7 +79,8 @@ class RightScaleCLI
 
     desc "shard", "Configure the RightScale shard used by the client."
     def shard()
-      @directives.merge!( { :api_url => "https://#{ask("RightScale shard (e.g. us-4.rightscale.com):")}" })
+      shard = ask("RightScale shard (e.g. us-4.rightscale.com):")
+      @directives.merge!( { :api_url => "https://#{shard}", :token_endpoint => "https://#{shard}/api/oauth2" })
       update_conf
     end
 
@@ -81,9 +95,18 @@ class RightScaleCLI
       account
       user
       password
+      # do not ask for the api access token as we'll generate this from the refresh token
+      # oauth
+      refresh
       shard
       api
       puts 'Configuration saved.'
+      if @directives[:refresh_token]
+        puts 'Refresh API token now? (y/n):'
+        if yesno
+          system 'rs refresh token'
+        end
+      end
     end
 
     #default_task :all

data/lib/rightscale_cli/deployments.rb

@@ -18,44 +18,61 @@ require 'thor'
 require 'yaml'
 require 'rightscale_cli/client'
 require 'rightscale_cli/logger'
+require 'rightscale_cli/config'
+require 'deployment_cat'
+require 'right_api_client'
 
 class RightScaleCLI
+  # Represents RightScale Deployments
   class Deployments < Thor
     namespace :deployments
 
     def initialize(*args)
       super
       @client = RightScaleCLI::Client.new(options)
-      @logger = RightScaleCLI::Logger.new()
+      @logger = RightScaleCLI::Logger.new
+      @config = RightScaleCLI::Config.new.directives
     end
 
-    # include render options
-    eval(IO.read("#{File.dirname(File.expand_path(__FILE__))}/render_options.rb"), binding)
+    class_option :xml,
+                 type: :boolean,
+                 default: false,
+                 aliases: '-X',
+                 required: false,
+                 desc: 'returns xml'
+    class_option :json,
+                 type: :boolean,
+                 default: false,
+                 aliases: '-J',
+                 required: false,
+                 desc: 'returns json'
 
-    desc "list", "Lists all deployments."
-    def list()
+    desc 'list', 'Lists all deployments'
+    def list
       @client.render(@client.get('deployments'), 'deployments')
     end
 
-    desc "create", "Creates a deployment."
+    desc 'create', 'Creates a deployment'
     def create(name, description)
-      @client.create('deployment', { :name => name, :description => description })
+      @client.create('deployment', name: name, description: description)
     end
 
-    desc "destroy", "Deletes a deployment."
+    desc 'destroy', 'Deletes a deployment'
     def destroy(deployment_id)
       @client.destroy('deployment', deployment_id)
     end
 
-    desc "servers", "Lists servers in a deployment."
+    desc 'servers', 'Lists servers in a deployment'
     def servers(deployment)
       @logger.info("Retrieving all servers in deployment, #{deployment}...")
-      @client.render(@client.show('deployments', deployment, 'servers'), 'servers')
+      @client.render(@client.show('deployments', deployment, 'servers'),
+                     'servers')
     end
 
-    desc "terminate", "Terminates all servers in a deployment."
+    desc 'terminate', 'Terminates all servers in a deployment'
     def terminate(deployment_id)
-      @client.client.deployments.index(:id=> deployment_id).show.servers.index.each do |server|
+      @client.client.deployments.index(id: deployment_id)
+        .show.servers.index.each do |server|
         unless server.state == 'inactive'
           @logger.info "Terminating #{server.href} (state: #{server.state}.)"
           server.terminate
@@ -63,7 +80,14 @@ class RightScaleCLI
       end
     end
 
-    def self.banner(task, namespace = true, subcommand = false)
+    desc 'export', 'Exports a deployment into a CAT file'
+    def export(deployment_id)
+      @config[:timeout] = nil
+      @client = RightApi::Client.new(@config)
+      deployment_to_cat_file @client, deployment_id, nil, nil
+    end
+
+    def self.banner(task, _namespace = true, subcommand = false)
       "#{basename} #{task.formatted_usage(self, true, subcommand)}"
     end
   end

data/lib/rightscale_cli/instances.rb

@@ -22,6 +22,17 @@ class RightScaleCLI
   class Instances < Thor
     namespace :instances
 
+    def initialize(*args)
+      super
+      @client = RightScaleCLI::Client.new(options)
+      @logger = RightScaleCLI::Logger.new()
+    end
+
+    # include render options
+    eval(IO.read(
+      "#{File.dirname(File.expand_path(__FILE__))}/render_options.rb"), binding
+    )
+
     desc "list", "Lists all instances for a given cloud."
     option :cloud, :desc => 'The cloud to filter on.', :type => :string, :required => true
     option :datacenter, :desc => 'The href of the datacenter to filter on', :type => :string, :required => false
@@ -37,9 +48,7 @@ class RightScaleCLI
     option :server_template, :desc => 'The href of the ServerTemplate to filter on.', :type => :string, :required => false
     option :state, :desc => 'The state of Instances to filter on.', :type => :string, :required => false
     def list()
-      instances = []
       filter = []
-
       filter.push("datacenter_href==#{options[:datacenter]}") if options[:datacenter]
       filter.push("deployment_href==#{options[:deployment]}") if options[:deployment]
       filter.push("name==#{options[:private_ip]}") if options[:name]
@@ -55,7 +64,21 @@ class RightScaleCLI
 
       @logger.debug "filter: #{filter}" if options[:debug]
 
-      @client.render(@client.clent.clouds(:id => options[:cloud]).show.instances(:filter => filter).index)
+      instances = []
+      @client.client.clouds(:id => options[:cloud]).show.instances(:filter => filter).index.each do |instance|
+        instance_href = instance.href
+        instance = instance.raw
+        instance['href'] = instance_href
+        instances.push(instance)
+      end
+      @client.render(instances, 'instances')
+    end
+
+    desc "show", "Shows attributes of a single instance."
+    option :cloud, :desc => 'The cloud to filter on.', :type => :string, :required => true
+    def show(instance_id)
+      filter = []
+      @client.render(@client.client.clouds(:id => options[:cloud]).show.instances.index(:id => instance_id).show.raw, 'instance')
     end
 
     desc "run-exec", "Runs a chef recipe or rightscript on instances of a given cloud."

data/lib/rightscale_cli/logger.rb

@@ -18,15 +18,17 @@ require 'logger'
 require 'rightscale_cli/config'
 
 class RightScaleCLI
+  # Represents a RightScale CLI Logger
   class Logger
     attr_accessor :log
-    
-    def initialize(*args)
+
+    def initialize(*)
       @log_init_msg = 'Initializing Logging using '
 
       if ENV['RIGHT_API_CLIENT_LOG']
-        if File.exists?(ENV['RIGHT_API_CLIENT_LOG'])
-          file = File.open(ENV['RIGHT_API_CLIENT_LOG'], File::WRONLY | File::APPEND)
+        if File.exist?(ENV['RIGHT_API_CLIENT_LOG'])
+          file = File.open(ENV['RIGHT_API_CLIENT_LOG'],
+                           File::WRONLY | File::APPEND)
         else
           file = ENV['RIGHT_API_CLIENT_LOG']
         end
@@ -38,14 +40,14 @@ class RightScaleCLI
       end
     end
 
-    def init_message()
+    def init_message
       @log.info @log_init_msg
     end
 
     def info(msg)
       @log.info msg
     end
-    
+
     def debug(msg)
       @log.debug msg
     end