softlayer-report-cli 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b038ab57c48cd72de0980ba48501b8304ba2e4e
+  data.tar.gz: ecf1c0152693d59d7c579fa3b4080c1224eef106
+SHA512:
+  metadata.gz: f3c675c38caf44728709d4c29512c644d03fd753f6312932f20116df3ea3582b809390c1641d29ba4b24a9370becc09628ac70971868b408d6480660170fae33
+  data.tar.gz: 7176472855bd6a8c10803d811884ba23c48648152b3a2b1960cb58ee76e4bdabea2c79193bf44df5392638f5562be8c2986dd412772b0798231d0dfb40f3bf6e

data/.gitignore

@@ -0,0 +1,30 @@
+Gemfile.lock
+.env
+.DS_Store
+.last_rev
+*.sublime-*
+vendor/bundle
+vendor/cache
+*.gem
+*.rbc
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.so
+*.o
+*.a
+mkmf.log
+.vagrant
+logs
+.idea
+.bundle/*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Renier Morales
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+Generic CLI written in Ruby for SoftLayer. Currently only supports account reporting and system cancellation.
+
+Supports various filtering and searching parameters, as well as multiple output formats (plain text,
+ CSV, JSON).
+
+## Examples
+
+    $ softlayer report -s datacenter:hou02 domain:foo.mydomain.com
+    +----------+---------------+--------------------------------+---------------+------------+-------+----------+---------+---------------------+
+    | ID       | TYPE          | HOSTNAME                       | IP            | DATACENTER | COST  | USERNAME | NAME    | EMAIL               |
+    +----------+---------------+--------------------------------+---------------+------------+-------+----------+---------+---------------------+
+    | 10756577 | VirtualServer | spzabclcent1.foo.mydomain.com  | 10.193.91.62  | Houston 2  | 30.24 | joedoe   | Joe Doe | joedoe@mydomain.com |
+    | 10756579 | VirtualServer | spzabclcent2.foo.mydomain.com  | 10.173.58.246 | Houston 2  | 30.24 | joedoe   | Joe Doe | joedoe@mydomain.com |
+    | 10390509 | VirtualServer | spzabclrhel71.foo.mydomain.com | 10.193.67.91  | Houston 2  | 74.16 | joedoe   | Joe Doe | joedoe@mydomain.com |
+    | 10390511 | VirtualServer | spzabclrhel72.foo.mydomain.com | 10.193.67.72  | Houston 2  | 74.16 | joedoe   | Joe Doe | joedoe@mydomain.com |
+    +----------+---------------+--------------------------------+---------------+------------+-------+----------+---------+---------------------+
+
+    $ softlayer report -s datacenter:hou02 domain:foo.mydomain.com -f json | jq
+    [
+        {
+            "cost": 30.24,
+            "datacenter": "Houston 2",
+            "email": "joedoe@mydomain.com",
+            "hostname": "spzabclcent1.foo.mydomain.com",
+            "id": 10756577,
+            "ip": "173.193.91.62",
+            "name": "Joe Doe",
+            "type": "VirtualServer",
+            "username": "joedoe"
+        },
+        {
+            "cost": 30.24,
+            "datacenter": "Houston 2",
+            "email": "joedoe@mydomain.com",
+            "hostname": "spzabclcent2.foo.mydomain.com",
+            "id": 10756579,
+            "ip": "184.173.58.246",
+            "name": "Joe Doe",
+            "type": "VirtualServer",
+            "username": "joedoe"
+        },
+        {
+            "cost": 74.16,
+            "datacenter": "Houston 2",
+            "email": "joedoe@mydomain.com",
+            "hostname": "spzabclrhel71.foo.mydomain.com",
+            "id": 10390509,
+            "ip": "173.193.67.91",
+            "name": "Joe Doe",
+            "type": "VirtualServer",
+            "username": "joedoe"
+        },
+        {
+            "cost": 74.16,
+            "datacenter": "Houston 2",
+            "email": "joedoe@mydomain.com",
+            "hostname": "spzabclrhel72.foo.mydomain.com",
+            "id": 10390511,
+            "ip": "173.193.67.72",
+            "name": "Joe Doe",
+            "type": "VirtualServer",
+            "username": "joedoe"
+        }
+    ]
+
+    $ softlayer report -s datacenter:hou02 domain:foo.mydomain.com -f csv
+    ID,TYPE,HOSTNAME,IP,DATACENTER,COST,USERNAME,NAME,EMAIL
+    10756577,VirtualServer,spzabclcent1.foo.mydomain.com,173.193.91.62,Houston 2,30.24,joedoe,Joe Doe,joedoe@mydomain.com
+    10756579,VirtualServer,spzabclcent2.foo.mydomain.com,184.173.58.246,Houston 2,30.24,joedoe,Joe Doe,joedoe@mydomain.com
+    10390509,VirtualServer,spzabclrhel71.foo.mydomain.com,173.193.67.91,Houston 2,74.16,joedoe,Joe Doe,joedoe@mydomain.com
+    10390511,VirtualServer,spzabclrhel72.foo.mydomain.com,173.193.67.72,Houston 2,74.16,joedoe,Joe Doe,joedoe@mydomain.com
+
+    $ softlayer report -s datacenter:hou02 domain:foo.mydomain.com -c id ip hostname name
+    +----------+--------------------------------+---------------+---------+
+    | ID       | IP                             | HOSTNAME      | NAME    |
+    +----------+--------------------------------+---------------+---------+
+    | 10756577 | spzabclcent1.foo.mydomain.com  | 10.193.91.62  | Joe Doe |
+    | 10756579 | spzabclcent2.foo.mydomain.com  | 10.173.58.246 | Joe Doe |
+    | 10390509 | spzabclrhel71.foo.mydomain.com | 10.193.67.91  | Joe Doe |
+    | 10390511 | spzabclrhel72.foo.mydomain.com | 10.193.67.72  | Joe Doe |
+    +----------+--------------------------------+---------------+---------+
+
+## Installation
+
+**Requires Ruby installed and the bundler gem**
+
+Currently, this is not yet in rubygems. Follow these steps to get it installed for now:
+
+    git clone https://github.com/renier/softlayer-report-cli.git
+    cd softlayer-report-cli.git
+    bundle install
+    bundle exec rake build
+    gem install pkg/*.gem
+
+## Usage
+
+    $ softlayer help
+    Commands:
+      softlayer cancel ID ...   # cancel a softlayer system or systems by ID
+      softlayer help [COMMAND]  # Describe available commands or one specific command
+      softlayer report          # print a softlayer account report
+
+    $ softlayer help report
+    Usage:
+      softlayer report
+
+    Options:
+      -u, [--username=USERNAME]        # SoftLayer username
+      -p, [--api-key=API_KEY]          # SoftLayer api key
+      -c, [--columns=one two three]    # List of columns to display
+                                       # Default: id type hostname ip datacenter cost username name email
+      -s, [--search=key:value]         # Search filters (e.g. datacenter:wdc01 domain:foobar.com)
+      -f, [--format=FORMAT]            # Output format
+                                       # Default: plain
+                                       # Possible values: plain, csv, json
+      -o, [--output-file=OUTPUT_FILE]  # Path to output file (default: stdout)
+
+    print a softlayer account report
+
+    $ softlayer help cancel
+    Usage:
+      softlayer cancel ID
+
+    cancel a softlayer system by ID
+
+Credentials can also be provided with a configuration file at _~/.softlayer_. See [softlayer-ruby](https://github.com/softlayer/softlayer-ruby/blob/master/lib/softlayer/Config.rb#L11) for details.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/softlayer

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'softlayer/cli'
+
+SoftLayer::CLI.start(ARGV)

data/lib/softlayer/cli.rb

@@ -0,0 +1,162 @@
+require 'softlayer_api'
+require 'thor'
+require 'softlayer/cli/version'
+require 'softlayer/cli/formatter'
+
+class Hash
+  def symbolize_keys!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+  end
+end
+
+module SoftLayer
+  class CLI < Thor
+    OUTPUT_TYPES = %w[plain csv json]
+    COLUMNS = %w[id type hostname ip datacenter cost username name email provision_date]
+    OBJECT_MASK =
+      'mask[billingItem[cancellationDate,recurringFee,hourlyRecurringFee,'\
+        'activeAssociatedChildren[recurringFee,hourlyRecurringFee],'\
+        'orderItem[order[userRecord[username,email,firstName,lastName]]]]]'
+
+    desc 'report', 'print a softlayer account report'
+    option :username,
+      type: :string, desc: 'SoftLayer username', aliases: '-u'
+    option :api_key,
+      type: :string, desc: 'SoftLayer api key', aliases: '-p'
+    option :columns,
+      type: :array, desc: 'List of columns to display',
+      default: COLUMNS.join(' '), aliases: '-c'
+    option :search,
+      type: :hash, desc: 'Search filters (e.g. datacenter:wdc01 domain:foobar.com)',
+      aliases: '-s'
+    option :format,
+      type: :string, desc: "Output format",
+      default: 'plain', enum: OUTPUT_TYPES, aliases: '-f'
+    option :output_file,
+      type: :string, desc: 'Path to output file (default: stdout)', aliases: '-o'
+    def report
+      # Create the softlayer client
+      client_opts = {}
+      client_opts[:username] = options['username'] if options['username']
+      client_opts[:api_key] = options['api_key'] if options['api_key']
+      SoftLayer::Client.default_client = SoftLayer::Client.new(client_opts)
+
+      search_opts = options['search'] ? {}.merge(options['search']) : {}
+      search_opts.symbolize_keys!
+      search_opts[:object_mask] = OBJECT_MASK
+      search_opts[:result_limit] = { offset: 0, limit: 150 }
+
+      column_opts = COLUMNS
+      column_opts = options['columns'] if options['columns'].is_a? Array
+
+      # Generate table
+      rows = []
+      %w[BareMetalServer VirtualServer].each do |class_name| # Do for both VMs and physical servers
+        loop do
+          servers = SoftLayer.const_get(class_name).find_servers(search_opts)
+          servers.each do |server|
+            # Ignore disconnected servers
+            next if server.respond_to?(:status) && server.status == 'DISCONNECTED'
+            # Ignore cancelled servers
+            cancellation_date = server['billingItem'] && server['billingItem']['cancellationDate']
+            next unless cancellation_date.nil? || cancellation_date.strip.empty?
+
+            # Gather column data
+            row = []
+            row << server.id if column_opts.include? 'id'
+            row << class_name if column_opts.include? 'type'
+            row << server.fqdn if column_opts.include? 'hostname'
+            row << (server['primaryIpAddress'] || server['primaryBackendIpAddress']) if column_opts.include? 'ip'
+            row << server['datacenter']['longName'] if column_opts.include? 'datacenter'
+
+            if server['billingItem']
+              cost = server['billingItem']['recurringFee'].to_f
+              if (server['billingItem']['hourlyRecurringFee'] &&
+                  !server['billingItem']['hourlyRecurringFee'].strip.empty?)
+                cost = server['billingItem']['hourlyRecurringFee'].to_f * 24 * 30
+              end
+              server['billingItem']['activeAssociatedChildren'].each do |child|
+                if child['hourlyRecurringFee'] && !child['hourlyRecurringFee'].strip.empty?
+                  cost += (child['hourlyRecurringFee'].to_f * 24 * 30)
+                else
+                  cost += child['recurringFee'].to_f
+                end
+              end
+              row << cost.round(2) if column_opts.include? 'cost'
+
+              user_record = server['billingItem']['orderItem']['order']['userRecord']
+              row << user_record['username'] if column_opts.include? 'username'
+              row << "#{user_record['firstName']} #{user_record['lastName']}" if column_opts.include? 'name'
+              row << user_record['email'] if column_opts.include? 'email'
+            else # Allow report to continue even when no billing item is found
+              row << '' if column_opts.include? 'cost'
+              row << '' if column_opts.include? 'username'
+              row << '' if column_opts.include? 'name'
+              row << '' if column_opts.include? 'email'
+            end
+
+            row << server['provisionDate'] if column_opts.include? 'provision_date'
+
+            rows << row
+          end
+
+          break if servers.size < search_opts[:result_limit][:limit]
+          search_opts[:result_limit][:offset] += search_opts[:result_limit][:limit]
+        end
+      end
+
+      # Output
+      CLIFormatter.format(
+        rows,
+        options['format'],
+        COLUMNS.reject { |c| !column_opts.include?(c) },
+        options['output_file']
+      )
+    end
+
+    desc 'cancel ID ...', 'cancel a softlayer system or systems by ID'
+    def cancel(*ids)
+      # Create the softlayer client
+      client_opts = {}
+      client_opts[:username] = options['username'] if options['username']
+      client_opts[:api_key] = options['api_key'] if options['api_key']
+      SoftLayer::Client.default_client = SoftLayer::Client.new(client_opts)
+
+      problem_ids = []
+      done_ids = []
+      while ids.size > 0
+        server = nil
+        begin
+          server = SoftLayer::VirtualServer.server_with_id(ids.last)
+        rescue
+          begin
+            server = SoftLayer::BareMetalServer.server_with_id(ids.last)
+          rescue
+          end
+        end
+
+        unless server
+          STDERR.puts "No server with id #{id} was found."
+          problem_ids << ids.pop
+          next
+        end
+
+        begin
+          server.cancel!
+          done_ids << ids.pop
+        rescue Exception => e
+          STDERR.puts "Error cancelling server #{id}: #{e}"
+          problem_ids << ids.pop
+        end
+      end
+
+      puts "Cancelled #{done_ids.size} servers."
+      if problem_ids.size > 0
+        puts "Had trouble cancelling servers #{problem_ids.join(', ')}."
+        exit 1
+      end
+    end
+  end
+end

data/lib/softlayer/cli/formatter.rb

@@ -0,0 +1,44 @@
+module SoftLayer
+  class CLIFormatter
+    def self.format(content, format = 'plain', headers = CLI::COLUMNS, output_file = nil)
+      send(format.to_sym, content, headers, output_file)
+    end
+
+    def self.plain(content, headers, output_file = nil)
+      require 'terminal-table'
+      table = Terminal::Table.new(headings: headers.map { |c| c.upcase }, rows: content)
+      CLISerializer.serialize(table, output_file)
+    end
+
+    def self.csv(content, headers, output_file = nil)
+      require 'csv'
+      csv_str = CSV.generate do |csv|
+        csv << headers.map { |c| c.upcase }
+        content.each do |row|
+          csv << row
+        end
+      end
+
+      CLISerializer.serialize(csv_str, output_file)
+    end
+
+    def self.json(content, headers, output_file = nil)
+      json_obj = []
+      content.each do |row|
+        json_obj << Hash[*headers.zip(row).flatten.compact]
+      end
+
+      CLISerializer.serialize(JSON.generate(json_obj), output_file)
+    end
+  end
+
+  class CLISerializer
+    def self.serialize(output, output_file = nil)
+      if output_file
+        IO.write(output_file, output)
+      else
+        puts output
+      end
+    end
+  end
+end

data/lib/softlayer/cli/version.rb

@@ -0,0 +1,3 @@
+module SoftLayer
+  CLI_VERSION = '0.2.0'
+end

data/softlayer-report-cli.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'softlayer/cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'softlayer-report-cli'
+  spec.version       = SoftLayer::CLI_VERSION
+  spec.authors       = ['Renier Morales']
+
+  spec.summary       = %q{SoftLayer Reporting CLI}
+  spec.description   = %q{SoftLayer Reporting CLI}
+  spec.homepage      = 'https://github.com/renier/softlayer-report-cli'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'softlayer_api', '~> 3.1.0'
+  spec.add_dependency 'thor', '~> 0.19.1'
+  spec.add_dependency 'terminal-table', '~> 1.5.2'
+
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: softlayer-report-cli
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Renier Morales
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: softlayer_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SoftLayer Reporting CLI
+email: 
+executables:
+- softlayer
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/softlayer
+- lib/softlayer/cli.rb
+- lib/softlayer/cli/formatter.rb
+- lib/softlayer/cli/version.rb
+- softlayer-report-cli.gemspec
+homepage: https://github.com/renier/softlayer-report-cli
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: SoftLayer Reporting CLI
+test_files: []