esp_sdk 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 346fea31e490e4806a446f57683828c302ef3289
-  data.tar.gz: 8c429d99558d3b111eb4eabb7d7a35419391ab23
+  metadata.gz: eec3d492b1abf2d98d6bbf35c1f88a90c5e2b602
+  data.tar.gz: f51d254cdef908e29b311ac812cf2654e14e1b8a
 SHA512:
-  metadata.gz: 6ad3f1c191a879a5c17b3042941b7a590918f48a34e597beaf1c06d293d653cb49ac958f4e539ee717d24cac092861fbfce903e870e8ec0be09557542e3e0d82
-  data.tar.gz: d68c27b4c8fd22fe0dd65a2c4d702b4f8d2a19376e5e826514f1f6d9c8a40f2f316dbf6d6549cccbc164418a463c73e35a2a9e05433bb11f11888526a1a5e246
+  metadata.gz: 7edfbd88ee1b306daba55f035da060d5b63eb22c4a3d37d7bc09f6d95b20c510df7756edb8b74f5f18ba1325bbc62929052e4486fb3db26304c3aceba0633981
+  data.tar.gz: 1ba56c34e806fe32835db2dc32339d3802f3b830ea3dd9021e470ceab3a223a063107fa8566ec1658883d4d4dd2759be3be3f902982f91d7148c55aea797b69c

data/.travis.yml

@@ -5,6 +5,7 @@ rvm:
   - 2.0.0
   - 2.1
   - 2.2
+  - 2.3.0
 script:
   - bundle exec rake test
   - bundle exec rake coveralls:push

data/CHANGELOG.md

@@ -1,6 +1,11 @@
-## [Unreleased]
+## 2.1.0 - 2015-01-15
 ### Added
 - Implemented searching using `where` on many object.
+- Add external account script.  Run with `esp a`
+- Added ability to set a proxy using either the `http_proxy` environment variable, or setting it manually wiht `ESP.http_proxy = <proxy>`
+
+### Changed
+- Changed the `esp_console` executable to just be `esp`.  Now start the console with `esp c`
 
 ## [2.0.0] - 2015-12-16
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    esp_sdk (2.0.0)
+    esp_sdk (2.1.0)
       activeresource (~> 4.0.0)
       api-auth
       rack
@@ -28,6 +28,13 @@ GEM
     ast (2.0.0)
     astrolabe (1.3.1)
       parser (~> 2.2)
+    awesome_print (1.6.1)
+    aws-sdk (2.1.36)
+      aws-sdk-resources (= 2.1.36)
+    aws-sdk-core (2.1.36)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.1.36)
+      aws-sdk-core (= 2.1.36)
     bourne (1.6.0)
       mocha (~> 1.1)
     builder (3.2.2)
@@ -62,6 +69,7 @@ GEM
       guard (~> 2.0)
       rubocop (~> 0.20)
     i18n (0.7.0)
+    jmespath (1.1.3)
     json (1.8.2)
     listen (3.0.3)
       rb-fsevent (>= 0.9.3)
@@ -139,6 +147,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  awesome_print
+  aws-sdk
   bourne
   bundler
   coveralls

data/README.md

@@ -13,7 +13,7 @@ This Readme is for the V2 version of the ESP SDK.  For V1 information, see the [
 
 Add this line to your application's Gemfile:
 
-    gem 'esp_sdk'
+     gem 'esp_sdk'
 
 And then execute:
 
@@ -53,6 +53,29 @@ end
       
 Get your HMAC keys from the Evident.io website, [esp.evident.io](https://esp.evident.io/settings/api_keys)
 
+## Set a Proxy URI
+
+If you need to go through a proxy server, you can set the proxy URI.
+You can set this directly:
+
+```ruby
+ESP.http_proxy = <proxy uri>
+```
+
+or, if in a Rails application, you can use the configure block in an initializer:
+
+```ruby
+ESP.configure do |config|
+  config.http_proxy = <proxy uri>
+end
+```
+
+Alternatively, the proxy can also be set with an environment variable.
+
+```
+export http_proxy=<proxy uri>
+```
+
 ## Appliance Users
 
 Users of Evident.io's AWS marketplace appliance will need to set the host for their appliance instance.
@@ -72,7 +95,6 @@ end
 
 Alternatively, the site can also be set with an environment variable.
 
-
 ```
 export ESP_HOST=<host for appliance instance>
 ```
@@ -197,7 +219,9 @@ espsdk:004:0> page4 = alerts.page(4)
 espsdk:004:0> alerts.current_page_number # => "25"
 espsdk:004:0> page4.current_page_number # => "4"
 ```
-    
+
+See ActiveResource::PaginatedCollection for all the pagination methods available.
+
 ## Associated Objects
 Most of the objects in the Evident.io SDK have a corresponding API call associated with it.  That means if you call an object's
 association, then that will make another API call.  For example:
@@ -218,37 +242,272 @@ of the relations wanted in an +include+ option.
 espsdk:004:0> external_account = ESP::ExternalAccount.find(3, include: 'organization,sub_orgnanization,team')
 ```
 
+```ruby
+espsdk:004:0> external_account = ESP::ExternalAccount.where(id_eq: 3, include: 'organization,sub_organization,team')
+```
+
 With that call, organization, sub_organization and team will all come back in the response, and calling, `external_account.organization`,
-`external_account.sub_organization` and `external_account.team`, will not make another API call.  Most objects' find method accepts the
-+include+ option.
-    
-See the [**Documentation**](http://www.rubydoc.info/gems/esp_sdk/ESP/ActiveResource/PaginatedCollection.html) for all the pagination methods available.
+`external_account.sub_organization` and `external_account.team`, will not make another API call.
+
+You can nest include requests with the dot property. For example, requesting `external_account.team` on an alert will expand the `external_account` property into a full `External Account` object, and will then expand the `team` property on that external account into a full `Team` object.
+Deep nesting is available as well.  `external_account.team.organization`
+
+```ruby
+alert = ESP::Alert.find(1, include: 'tags,external_account.team')
+#=> <ESP::Alert:0x007fb82acd3298 @attributes={"id"=>"1", "type"=>"alerts"...}>
+
+alerts = ESP::Alert.where(report_id: 4, include: 'tags,external_account.team')
+#=> #<ActiveResource::PaginatedCollection:0x007fb82b0b54b0 @elements=[#<ESP::Alert:0x007fb82b0b1fb8 @attributes={"id"=>"1", "type"=>"alerts"...>
+```
+
+Most objects' find and where methods accept the +include+ option.  Those methods that accept the +include+ option are documented with the available associations that are includable.
+
+## Filtering/Searching
+For objects that implement `where`, parameters can be passed that will filter the results based on the search criteria specified.
+The criteria that can be specified depends on the object.  Each object is documented whether it implements `where` or not,
+and if so, which attributes can be included in the search criteria.
+
+### Searching
+
+The primary method of searching is by using what is known as *predicates*.
+
+Predicates are used within Evident.io API search queries to determine what information to
+match. For instance, the `cont` predicate, when added to the `name` attribute, will check to see if `name`` contains a value using a wildcard query.
+
+```ruby
+ESP::Signature.where(name_cont: 'dns')
+#=> will return signatures `where name LIKE '%dns%'`
+```
+
+### OR Conditions
+
+You can also combine predicates for OR queries:
+
+```ruby
+ESP::Signature.where(name_or_description_cont: 'dns')
+#=> will return signatures `where name LIKE '%dns%' or description LIKE '%dns%'`
+```
+
+### Conditions on Relationships
+
+The syntax for queries on an associated relationship is to just append the association name to the attribute:
+
+```ruby
+ESP::Suppression.where(regions_code_eq: 'us_east_1')
+#=> will return suppressions that have a region relationship `where code = 'us_east_1'`
+```
+
+### Complex Filtering
+
+Add multiple attributes and predicates to form complex queries:
+
+```ruby
+ESP::Suppression.where(regions_code_start: 'us', created_by_email_eq: 'bob@mycompany.com', resource_not_null: '1')
+#=> will return suppressions that have a region relationship `where code LIKE 'us%'` and created_by relationship `where email = 'bob@mycompany.com'` and `resource IS NOT NULL`
+```
+
+You can also change the `combinator` for complex queries from the default `AND` to `OR` by adding the `m: 'or'` parameter
+
+```ruby
+ESP::Suppression.where(regions_code_start: 'us', created_by_email_eq: 'bob@mycompany.com', resource_not_null: '1', m: 'or')
+#=> will return suppressions that have a region relationship `where code LIKE 'us%'` **OR** created_by relationship `where email = 'bob@mycompany.com'` **OR** `resource IS NOT NULL`
+```
+
+### Bad Attributes
+
+**Please note:** any attempt to use a predicate for an attribute that does not exist will return a
+*422 (Unprocessable Entity)* response. For instance, this will not work:
+
+```ruby
+ESP::Suppression.where(bad_attribute_eq: 'something')
+#=> ActiveResource::ResourceInvalid: Failed.  Response code = 422.  Response message = Invalid search term bad_attribute_eq.
+```
+
+**Also note:** any attempt to use a predicate for an attribute that exists on the object, but is not a documented searchable attribute will _silently fail_
+and will be excluded from the search criteria.
+
+## Available Predicates
+
+Below is a list of the available predicates and their opposites.
+
+### eq (equals)
+
+The `eq` predicate returns all records where a field is *exactly* equal to a given value:
+
+```ruby
+ESP::Suppression.where(regions_code_eq: 'us_east_1')
+#=> will return suppressions that have a region relationship `where code = 'us_east_1'`
+```
+
+**Opposite: `not_eq`**
+
+### lt (less than)
+
+The `lt` predicate returns all records where a field is less than a given value:
+
+```ruby
+ESP::Report.where(created_at_lt: 1.hour.ago)
+#=> will return reports `where created_at < '2015-11-11 16:25:30'`
+```
+
+**Opposite: `gt` (greater than)**
+
+### lteq (less than or equal to)
+
+The `lteq` predicate returns all records where a field is less than *or equal to* a given value:
+
+```ruby
+ESP::Report.where(created_at_lteq: 1.hour.ago)
+#=> will return reports `where created_at <= '2015-11-11 16:25:30'`
+```
+
+**Opposite: `gteq` (greater than or equal to)**
+
+### in
+
+The `in` predicate returns all records where a field is within a specified list:
+
+```ruby
+ESP::Signature.where(risk_level_in: ['Low', 'Medium'])
+#=> will return signatures `where risk_level IN ('Low', 'Medium')`
+```
+
+**Opposite: `not_in`**
+
+### cont (contains)
+
+The `cont` predicate returns all records where a field contains a given value:
+
+```ruby
+ESP::Signature.where(name_cont: 'dns')
+#=> will return signatures `where name LIKE '%dns%'`
+```
+
+**Opposite: `not_cont`**
+
+**Please note:** This predicate is only available on attributes listed in the "Valid Matching Searchable Attributes"" section
+for each implemented `where` method.
+
+### cont_any (contains any)
+
+The `cont_any` predicate returns all records where a field contains any of given values:
+
+```ruby
+ESP::Signature.where(name_cont_any: ['dns', 'EC2'])
+#=> will return signatures `where name LIKE '%dns%' or name LIKE '%EC2%'`
+```
+
+**Opposite: `not_cont_any`**
+
+**Please note:** This predicate is only available on attributes listed in the "Valid Matching Searchable Attributes"" section
+for each implemented `where` method.
+
+
+### start (starts with)
+
+The `start` predicate returns all records where a field begins with a given value:
+
+```ruby
+ESP::Signature.where(name_start: 'dns')
+#=> will return signatures `where name LIKE 'dns%'`
+```
+
+**Opposite: `not_start`**
+
+**Please note:** This predicate is only available on attributes listed in the "Valid Matching Searchable Attributes"" section
+for each implemented `where` method.
+
+### end (ends with)
+
+The `end` predicate returns all records where a field ends with a given value:
+
+```ruby
+ESP::Signature.where(name_end: 'dns')
+#=> will return signatures `where name LIKE '%dns'`
+```
+
+**Opposite: `not_end`**
+
+**Please note:** This predicate is only available on attributes listed in the "Valid Matching Searchable Attributes"" section
+for each implemented `where` method.
+
+### present
+
+The `present` predicate returns all records where a field is present (not null and not a
+blank string).
+
+```ruby
+ESP::Signature.where(identifier_present: '1')
+#=> will return signatures `where identifier IS NOT NULL AND identifier != ''`
+```
+
+**Opposite: `blank`**
+
+### null
+
+The `null` predicate returns all records where a field is null:
+
+```ruby
+ESP::Signature.where(identifier_null: 1)
+#=> will return signatures `where identifier IS NULL`
+```
+
+**Opposite: `not_null`**
+
+## Sorting
+
+Lists can also be sorted by adding the `sorts` parameter with the field to sort by to the `filter` parameter.
+
+```ruby
+ESP::Signature.where(name_cont: 'dns', sort: 'risk_level desc')
+#=> will return signatures `where name LIKE '%dns%'` sorted by `risk_level` in descending order.
+```
+
+Lists can be sorted by multiple fields by specifying an ordered array.
+
+```ruby
+ESP::Signature.where(name_cont: 'dns', sorts: ['risk_level desc', 'created_at'])
+#=> will return signatures `where name LIKE '%dns%'` sorted by `risk_level` in descending order and then by `created_at` in ascending order.
+```
 
 ## Available Objects
-* [ESP::Alert](http://www.rubydoc.info/gems/esp_sdk/ESP/Alert.html)
-* [ESP::CloudTrailEvent](http://www.rubydoc.info/gems/esp_sdk/ESP/CloudTrailEvent.html)
-* [ESP::ContactRequest](http://www.rubydoc.info/gems/esp_sdk/ESP/ContactRequest.html)
-* [ESP::CustomSignature](http://www.rubydoc.info/gems/esp_sdk/ESP/CustomSignature.html)
-* [ESP::Dashboard](http://www.rubydoc.info/gems/esp_sdk/ESP/Dashboard.html)
-* [ESP::ExternalAccount](http://www.rubydoc.info/gems/esp_sdk/ESP/ExternalAccount.html)
-* [ESP::Organization](http://www.rubydoc.info/gems/esp_sdk/ESP/Organization.html)
-* [ESP::Region](http://www.rubydoc.info/gems/esp_sdk/ESP/Region.html)
-* [ESP::Report](http://www.rubydoc.info/gems/esp_sdk/ESP/Report.html)
-* [ESP::Service](http://www.rubydoc.info/gems/esp_sdk/ESP/Service.html)
-* [ESP::Signature](http://www.rubydoc.info/gems/esp_sdk/ESP/Signature.html)
-* [ESP::Stat](http://www.rubydoc.info/gems/esp_sdk/ESP/Stat.html)
-* [ESP::SubOrganization](http://www.rubydoc.info/gems/esp_sdk/ESP/SubOrganization.html)
-* [ESP::Suppression](http://www.rubydoc.info/gems/esp_sdk/ESP/Suppression.html)
-* [ESP::Suppression::Region](http://www.rubydoc.info/gems/esp_sdk/ESP/Suppression::Region.html)
-* [ESP::Suppression::Signature](http://www.rubydoc.info/gems/esp_sdk/ESP/Suppression::Signature.html)
-* [ESP::Suppression::UniqueIdentifier](http://www.rubydoc.info/gems/esp_sdk/ESP/Suppression::UniqueIdentifier.html)
-* [ESP::Tag](http://www.rubydoc.info/gems/esp_sdk/ESP/Tag.html)
-* [ESP::Team](http://www.rubydoc.info/gems/esp_sdk/ESP/Team.html)
-* [ESP::User](http://www.rubydoc.info/gems/esp_sdk/ESP/User.html)
+* ESP::Alert
+* ESP::CloudTrailEvent
+* ESP::ContactRequest
+* ESP::CustomSignature
+* ESP::Dashboard
+* ESP::ExternalAccount
+* ESP::Organization
+* ESP::Region
+* ESP::Report
+* ESP::Service
+* ESP::Signature
+* ESP::Stat
+* ESP::Stat
+* ESP::Stat
+* ESP::Stat
+* ESP::Stat
+* ESP::SubOrganization
+* ESP::Suppression
+* ESP::Suppression::Region
+* ESP::Suppression::Signature
+* ESP::Suppression::UniqueIdentifier
+* ESP::Tag
+* ESP::Team
+* ESP::User
 
 # Console
-The Evident.io SDK gem also provides an IRB console you can use if not using it in a Rails app.  Run it with `bin/esp_console`
+The Evident.io SDK gem also provides an IRB console you can use if not using it in a Rails app.  Run it with `esp console` or use the shortcut `esp c`
+
+# Add External Account Script
+The `esp` executable can also run a script that will create an external account and team for an already created sub organization that has the name 'AutoCreate'.
+The script can be run with the command `esp add_external_account` or the shortcut `esp a`.
+
+To run this script you will need to install the aws-sdk gem.
+
+     gem install aws-sdk
 
+Additional information can be found in the help.  `esp add_external_account -h`
 
 ## Contributing
 

data/bin/esp

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+ARGV << '--help' if ARGV.empty?
+
+aliases = {
+  "c"  => "console",
+  "a"  => "add_external_account"
+}
+
+command = ARGV.shift
+command = aliases[command] || command
+
+require_relative '../lib/esp/commands/commands_tasks'
+
+ESP::CommandsTasks.new(ARGV).run_command!(command)
+

data/esp_sdk.gemspec

@@ -34,6 +34,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'factory_girl'
   spec.add_development_dependency 'rdoc'
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'aws-sdk'
 
   spec.add_dependency 'activeresource', '~> 4.0.0'
   spec.add_dependency 'api-auth'

data/lib/esp/aws_clients.rb

@@ -0,0 +1,60 @@
+require 'aws-sdk'
+
+module ESP # :nodoc: all
+  class AWSClients
+    include ActiveModel::Validations
+
+    ESP_OWNER_ID = { "production" => "613698206329".freeze }.freeze
+    AWS_ROLE_NAME       = "Evident-Service-Role-AutoCreate".freeze
+    AWS_ROLE_POLICY_ARN = "arn:aws:iam::aws:policy/SecurityAudit".freeze
+
+    validates :owner_id, length: { is: 12 }, numericality: true
+
+    def create_and_attach_role!(external_account_id)
+      role = iam.create_role(role_name: AWS_ROLE_NAME, assume_role_policy_document: trust_policy(external_account_id))
+      iam.attach_role_policy(role_name: AWS_ROLE_NAME, policy_arn: AWS_ROLE_POLICY_ARN)
+      role
+    end
+
+    def owner_id
+      @owner_id ||= ec2.describe_security_groups.security_groups[0].owner_id
+    end
+
+    private
+
+    def ec2
+      @ec2 ||= Aws::EC2::Client.new
+    end
+
+    def iam
+      @iam ||= Aws::IAM::Client.new
+    end
+
+    def esp_owner_id
+      ESP_OWNER_ID.fetch(ESP.env, "762160981991")
+    end
+
+    def trust_policy(external_account_id) # rubocop:disable Metrics/MethodLength
+      <<TRUST_POLICY
+  {
+    "Version": "2012-10-17",
+    "Statement": [
+      {
+        "Sid": "",
+        "Effect": "Allow",
+        "Principal": {
+          "AWS": "arn:aws:iam::#{esp_owner_id}:root"
+        },
+        "Action": "sts:AssumeRole",
+        "Condition": {
+          "StringEquals": {
+            "sts:ExternalId": "#{external_account_id}"
+          }
+        }
+      }
+    ]
+  }
+TRUST_POLICY
+    end
+  end
+end

data/lib/esp/commands/add_external_account.rb

@@ -0,0 +1,57 @@
+require 'optparse'
+
+ARGV.clone.options do |opts|
+  opts.banner = "Usage: esp add_external_account"
+
+  opts.separator ""
+
+  opts.on("-h", "--help",
+          "Show this help message.") do
+    puts opts # rubocop:disable Rails/Output
+    exit
+  end
+
+  opts.separator ""
+  opts.separator "Adds external accounts to ESP"
+  opts.separator ""
+  opts.separator "    NOTE: This program automatically generates new teams for every external account added. Some modifications may"
+  opts.separator "    be required if you would like to organize accounts into specific teams. Please contact support@evident.io"
+  opts.separator "    if you have any questions."
+  opts.separator ""
+  opts.separator "    AWS SDK for Ruby v2 required"
+  opts.separator "      Install it by running `gem install aws-sdk`"
+  opts.separator "      http://docs.aws.amazon.com/sdkforruby/api/"
+  opts.separator ""
+  opts.separator "    The AWS SDK for Ruby requires credentials to be set via environment variables, configuration file,"
+  opts.separator "    or within the program. Also, you must set an AWS region for the SDK to communicate with the AWS"
+  opts.separator "    service endpoints. It is recommended that you set environment variables before proceeding."
+  opts.separator ""
+  opts.separator "    Required variables:"
+  opts.separator "      ENV['AWS_REGION']"
+  opts.separator "      ENV['AWS_ACCESS_KEY_ID']"
+  opts.separator "      ENV['AWS_SECRET_ACCESS_KEY']"
+  opts.separator "      ENV['AWS_SESSION_TOKEN'] (if generating credentials using STS AssumeRole)"
+  opts.separator ""
+  opts.separator "    The ESP SDK for Ruby requires credentials to be set via environment variables or within the program."
+  opts.separator "    It is recommended that you set environment variables before proceeding."
+  opts.separator "    See the documentation for more information.  http://www.rubydoc.info/gems/esp_sdk/"
+  opts.separator ""
+  opts.separator "    Required variables:"
+  opts.separator "      ENV['ESP_ACCESS_KEY_ID']"
+  opts.separator "      ENV['ESP_SECRET_ACCESS_KEY']"
+  opts.separator ""
+  opts.separator "    Generate ESP keys at:"
+  opts.separator "      https://esp.evident.io/settings/profile"
+  opts.separator ""
+
+  opts.parse!
+end
+
+begin
+  external_account = ESP::ExternalAccountCreator.new.create
+  puts "done on #{external_account.created_at}" # rubocop:disable Rails/Output
+rescue ESP::AddExternalAccountError => e
+  puts e.message.inspect # rubocop:disable Rails/Output
+  puts e.backtrace # rubocop:disable Rails/Output
+  exit e.exit_code
+end

data/lib/esp/commands/commands_tasks.rb

@@ -0,0 +1,106 @@
+module ESP
+  # This is a class which takes in an esp command and initiates the appropriate
+  # initiation sequence.
+  #
+  # Warning: This class mutates ARGV because some commands require manipulating
+  # it before they are run.
+  class CommandsTasks # :nodoc:
+    attr_reader :argv
+
+    HELP_MESSAGE = <<-EOT
+Usage: esp COMMAND [environment] [ARGS]
+
+The ESP commands are:
+ console                      Start the ESP console (short-cut alias: "c")
+ add_external_account         Adds external accounts to ESP (short-cut alias: "a")
+
+All commands can be run with -h (or --help) for more information.
+    EOT
+
+    COMMAND_WHITELIST = %w(console add_external_account version help)
+
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def run_command!(command)
+      command = parse_command(command)
+      if COMMAND_WHITELIST.include?(command)
+        set_env!
+        require_relative '../../../lib/esp_sdk'
+        send(command)
+      else
+        write_error_message(command)
+      end
+    end
+
+    def console
+      require_command!("console")
+
+      print_banner
+      ESP::Console.new.start
+    end
+
+    def add_external_account
+      require_command!("add_external_account")
+    end
+
+    def version
+      puts "ESP #{ESP::VERSION}" # rubocop:disable Rails/Output
+      exit(0)
+    end
+
+    def help
+      write_help_message
+    end
+
+    private
+
+    def shift_argv!
+      argv.shift if argv.first && argv.first[0] != '-'
+    end
+
+    def require_command!(command)
+      require_relative "./#{command}"
+    end
+
+    def set_env!
+      ENV['ESP_ENV'] = argv.first if argv.first && argv.first[0] != '-'
+    end
+
+    def write_help_message
+      puts HELP_MESSAGE # rubocop:disable Rails/Output
+    end
+
+    def write_error_message(command)
+      puts "Error: Command '#{command}' not recognized" # rubocop:disable Rails/Output
+      write_help_message
+      exit(1)
+    end
+
+    def parse_command(command)
+      case command
+      when '--version', '-v'
+        'version'
+      when '--help', '-h'
+        'help'
+      else
+        command
+      end
+    end
+
+    def print_banner
+      begin
+        puts File.read(File.expand_path(File.dirname(__FILE__) + '/../../../assets/esp_logo.ans')) # rubocop:disable Rails/Output
+      rescue # rubocop:disable Lint/HandleExceptions
+        # swallow the error
+      end
+      print <<-banner # rubocop:disable Rails/Output
+
+      Evident Security Platform Console #{ESP::VERSION}
+      Copyright (c) 2013-#{Time.current.year} Evident Security, All Rights Reserved.
+      http://www.evident.io
+      banner
+    end
+  end
+end