groove-ey-core 3.6.1

data/examples/boot_env.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+# Very basic example of how to boot a given environment from a blueprint
+# For more info visit http://developer.engineyard.com
+
+require 'ey-core'
+require 'optparse'
+require 'yaml'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: boot_env.rb [options]"
+
+  opts.on('-a', '--account NAME', 'Account name') { |v| options[:account_name] = v }
+  opts.on('-e', '--environment NAME', 'Environment name') { |v| options[:environment_name] = v }
+  opts.on('-b', '--blueprint NAME', 'Blueprint name') { |v| options[:blueprint_name] = v }
+
+end.parse!
+
+# Token comes from '~/.eyrc'
+eyrc = YAML.load_file(File.expand_path("~/.eyrc"))
+
+#client = Ey::Core::Client.new(token: "abcdefghijklmnrstuvwxyz123456789")
+client = Ey::Core::Client.new(token: eyrc['api_token'])
+
+# Account name as shown in cloud.engineyard.com
+account = client.accounts.first(name: options[:account_name])
+
+# Environment's name
+environment = account.environments.first(name: options[:environment_name])
+
+if environment.servers.count > 0 then
+  puts "Environment has instances running, are you sure you want to boot it?"
+  exit
+end
+
+# Get blueprint's name for cloud.engineyard.com
+blueprint = environment.blueprints.first(name: options[:blueprint_name])
+if !blueprint then
+  puts "Could not find the specified blueprint."
+  puts "Check cloud.engineyard.com for more details."
+  exit
+end
+  
+env_options = {"blueprint_id": blueprint.id}
+puts "Booting environment using an specific blueprint...."
+provision_request = environment.boot(env_options)
+
+# Booting the environment instance with a timeout of 1800sec (30mins).
+# Adjust as necessary depending of the size of the environment.
+provision_request.ready!(1800)
+
+puts "-------------------"
+if !provision_request.successful? then
+  puts "Boot environment FAILED!!!"
+  puts "Check cloud.engineyard.com for more details"
+  exit
+end
+
+puts "Boot environment SUCCEDED!!!"

data/examples/console/README.md

@@ -0,0 +1,14 @@
+## Examples and snippets to use with the `ey-core console`
+
+### Getting started
+
+With the _ey-core_ gem comes the `ey-core console` utility which allows to query the CoreAPI interactively.  Below are a series of snippets with commands that will allow actions that normally are done through the EY dashboard, and others which aren't implemented yet but the CoreAPI already supports.
+
+The backend will automatically allow/reject actions based on the api token the console is using.  Upon a successful `ey-core login` said token is written on `$HOME/.ey-core` and picked up from there by the console.  It's a good practice to issue `ey-core whoami` before opening the console to double check that the desired user is logged in.
+
+- Addresses
+   - [List addresses allocated to the account](address.md#list-addresses-on-an-account)
+   - [Provision a new address](address.md#provision-new-address)
+   - [Attach an address to an instance/server](address.md#attach-address-to-instance)
+   - [Detach an address from an instance/server](address.md#detach-address-from-instance)
+

data/examples/console/address.md

@@ -0,0 +1,51 @@
+# IP Addresses
+
+It's advised for each operation to capture the request via an *<operation>_prov_req* variable, which will hold the operation's status.  The snippets below just wait for the request to finish (or timeout in 300sec), but the progress can be tracked issuing `<operation>_prov_req.reload` regularly.
+
+-
+
+<a name="list-addresses-on-an-account"></a>
+### List IPs addresses allocated to an account
+
+```
+addresses
+```
+
+-
+
+<a name="provision-new-address"></a>
+### Provision a new IP address on the account
+
+```
+new_address_specs = {:provider_id => "23952", :location => "us-east-1"}
+address_prov_req = addresses.create(new_eip_specs)
+address_prov_req.ready!(300)
+```
+
+-
+
+<a name="attach-address-to-instance"></a>
+### Attach an address to an instance
+
+```
+addresses
+address = addresses.first(ip_address: "111.222.333.444")
+attach_prov_req = address.attach(servers.first(provisioned_id: "i-aabbccdd"))
+attach_prov_req.ready!(300)
+```
+
+-
+
+<a name="detach-address-from-instance"></a>
+### Detach an address from an instance
+
+```
+addresses
+eip = addresses.first(ip_address: "111.222.333.444")
+detach_prov_req = eip.detach
+detach_prov_req.ready!(300)
+```
+
+-
+
+

data/examples/stop_env.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+# Very basic example of how to stop a given environment.
+# For more info visit http://developer.engineyard.com 
+
+require 'ey-core'
+require 'optparse'
+require 'yaml'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: stop_env.rb [options]"
+
+  opts.on('-a', '--account NAME', 'Account name') { |v| options[:account_name] = v }
+  opts.on('-e', '--environment NAME', 'Environment name') { |v| options[:environment_name] = v }
+
+end.parse!
+
+# Token comes from '~/.eyrc'
+eyrc = YAML.load_file(File.expand_path("~/.eyrc"))
+
+client = Ey::Core::Client.new(token: eyrc['api_token'])
+
+# Account name as shown in cloud.engineyard.com
+account = client.accounts.first(name: options[:account_name])
+
+# Environment's name
+environment = account.environments.first(name: options[:environment_name])
+
+if environment.servers.count == 0 then
+  puts "Environment doesn't have instances running, are you sure it isn't stopped already?"
+  exit
+end
+
+puts "Stopping environment #{environment.name}...."
+deprovision_request = environment.deprovision
+
+# Stoping the environment with a timeout of 1200sec.
+# Adjust as necessary depending of the size of the environment.
+deprovision_request.ready!(1200)
+
+puts "-------------------"
+
+if !deprovision_request.successful? then 
+  puts "Stop environment FAILED!!!"
+  puts "Check cloud.engineyard.com for more details"
+  exit
+end
+
+puts "Stop environment SUCCEDED!!!"
+

data/examples/terminate_instance.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+# Very basic example of how to terminate a given instance in a given environment.
+# For more info visit http://developer.engineyard.com
+
+require 'ey-core'
+require 'optparse'
+require 'yaml'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: terminate_instance.rb [options]"
+
+  opts.on('-a', '--account NAME', 'Account name') { |v| options[:account_name] = v }
+  opts.on('-e', '--environment NAME', 'Environment name') { |v| options[:environment_name] = v }
+  opts.on('-n', '--iname NAME', 'Instance name') { |v| options[:instance_name] = v }
+  opts.on('-s', '--skip_snapshot', 'Skip snapshotting the volumes') { |v| options[:skip_snapshot] = true }
+
+end.parse!
+
+# Token comes from '~/.eyrc'
+eyrc = YAML.load_file(File.expand_path("~/.eyrc"))
+
+client = Ey::Core::Client.new(token: eyrc['api_token'])
+
+# Account name as shown in cloud.engineyard.com
+account = client.accounts.first(name: options[:account_name])
+
+# Environment's name
+environment = account.environments.first(name: options[:environment_name])
+
+# Instance's name
+instance_name = options[:instance_name]
+
+# Skip snapshot
+skip_snapshot = options[:skip_snapshot] ? true : false
+
+puts "Terminating instance #{instance_name} on environment #{environment.name}...."
+
+servers = environment.servers.select{|s| s.name == instance_name}
+if !servers then
+  puts "Couldn't find instance #{instance_name} on environment #{environment.name}!!!!"
+  puts "Check cloud.engineyard.com for more details"
+  exit
+end
+
+server = servers[0]
+deprovision_request = server.destroy!(skip_snapshot)
+if !deprovision_request then
+  puts "Termination of instance #{instance_name} FAILED!!!!"
+  puts "Check cloud.engineyard.com for more details"
+  exit
+end
+
+# Terminating the instance with a timeout of 1200sec (20min) as a ballpark figure.
+# Adjust as necessary depending of the size/role of the instance.
+deprovision_request.ready!(1200)
+
+puts "*"
+puts "Instance #{instance_name} terminated successfully"
+puts "-------------------"
+

data/ey-core.gemspec

@@ -0,0 +1,51 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ey-core/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "groove-ey-core"
+  gem.version       = Ey::Core::VERSION
+  gem.authors       = ["Engine Yard Engineering", "Groove"]
+  gem.email         = ["engineering@engineyard.com"]
+  gem.description   = %q{Engine Yard Core API Ruby Client}
+  gem.summary       = %q{Client library providing real and mock functionality for accessing Engine Yard's Core API}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.licenses      = ["MIT"]
+
+  gem.required_ruby_version = ">= 2.6.3"
+
+  gem.add_dependency "addressable"
+
+  gem.add_dependency "awesome_print"
+  gem.add_dependency "belafonte"
+  gem.add_dependency "cistern", "~> 0.12.3"
+  gem.add_dependency "colorize"
+  gem.add_dependency "ey-hmac", "~> 2.0"
+  gem.add_dependency "escape"
+  gem.add_dependency "faraday", "~> 0.9"
+  gem.add_dependency "faraday_middleware", "~> 0.9"
+  gem.add_dependency "rack"
+  gem.add_dependency "faye"
+  gem.add_dependency "highline"
+  gem.add_dependency "json", "< 2.0"
+  gem.add_dependency "mime-types"
+  gem.add_dependency "oj"
+  gem.add_dependency "oj_mimic_json"
+  gem.add_dependency "pry"
+  gem.add_dependency "sshkey",  "~> 1.6"
+  gem.add_dependency "table_print"
+
+  gem.add_development_dependency "pry-nav"
+  gem.add_development_dependency "rspec", "~> 3.0"
+  gem.add_development_dependency "ffaker"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "aruba", "~> 0.11"
+  gem.add_development_dependency "cucumber", "~> 2.1"
+  gem.add_development_dependency "factis", "~> 1.0"
+end

data/features/accounts.feature

@@ -0,0 +1,13 @@
+Feature: Accounts
+  In order to know what Engine Yard accounts I can access
+  As a User
+  I want to be able to list the accounts with which I'm associated
+
+  Background:
+    Given I'm an Engine Yard user
+    And ey-core is configured with my cloud token
+    And I'm associated with several accounts
+
+  Scenario: Listing my accounts
+    When I run `ey-core accounts`
+    Then I see the name and ID of each of my accounts

data/features/applications.feature

@@ -0,0 +1,29 @@
+Feature: Applications
+  In order to determine what I can work with
+  As a User
+  I want to be able to list the applications that live in my accounts
+
+  Background:
+    Given I'm an Engine Yard user
+    And ey-core is configured with my cloud token
+    And I have the following accounts:
+      | Account Name  |
+      | one           |
+      | two           |
+      | three         |
+    And each of my accounts has several applications
+
+  Scenario: Listing all of my applications
+    When I run `ey-core applications`
+    Then I see the name and ID for all of my applications
+
+  Scenario Outline: Listing applications for a specific account
+    When I run `ey-core applications <Account Flag> one`
+    Then I see the applications in the one account
+    But I do not see applications from other accounts
+
+    Examples:
+      | Account Flag  |
+      | -a            |
+      | --account     |
+

data/features/current_user.feature

@@ -0,0 +1,14 @@
+Feature: Current User
+  In order to ensure that I'm logged into the right account
+  As a User
+  I want to be able to see my user information
+
+  Background:
+    Given I'm an Engine Yard user
+    And ey-core is configured with my cloud token
+
+  Scenario: Getting the current user information
+    When I run `ey-core current_user`
+    Then I should see my user ID
+    And I should see my email address
+    And I should see my name

data/features/docker_registry_credentials.feature

@@ -0,0 +1,21 @@
+Feature: Docker Registry Credentials
+  In order to authorize the Docker Engine with the AWS ECR registry
+  As a User
+  I want to be able to retrieve the Docker authorization credentials
+
+  Background:
+    Given I'm an Engine Yard user
+    And ey-core is configured with my cloud token
+    And I have the following accounts:
+      | Account Name  |
+      | one           |
+      | two           |
+
+  Scenario Outline: Retrieving Docker authorization credentials
+    When I run `ey-core get-docker-registry-login <Account Flag> one <Location Flag> us-east-1`
+    Then I see the docker login command
+
+    Examples:
+      | Account Flag  | Location Flag |
+      | -c            | -l            |
+      | --account     | --location    |

data/features/environment_variables.feature

@@ -0,0 +1,54 @@
+Feature: Environment Variables
+  In order to know current values of environment variables assigned to my Engine Yard environments
+  As a User
+  I want to be able to list the environment variables for environments which I'm associated
+
+  Background:
+    Given I'm an Engine Yard user
+    And ey-core is configured with my cloud token
+    And I have the following accounts:
+      | Account Name  |
+      | one           |
+      | two           |
+      | three         |
+    And I have the following applications:
+      | Account Name  | Application Name |
+      | one           | blog_app         |
+      | two           | todo_app         |
+    And I have the following environments:
+      | Application Name  | Environment Name  |
+      | blog_app          | staging           |
+      | blog_app          | production        |
+      | todo_app          | staging           |
+    And I have the following environment variables:
+      | Name          | Value               | Application Name  | Environment Name  | Sensitive |
+      | SECRET_BASE   | abc=                | blog_app          | staging           | false     |
+      | DB_PASSWORD   | 123qweasd!!         | blog_app          | staging           | true      |
+      | SECRET_BASE   | qwe=                | blog_app          | production        | false     |
+      | DB_PASSWORD   | 987qweasd!!         | blog_app          | production        | true      |
+      | DB_PASSWORD   | my_secure_password  | todo_app          | staging           | true      |
+
+  Scenario: Listing all of my environment variables
+    When I run `ey-core environment_variables`
+    Then I see the name and value for all of my environments as well as name of associated environment and application
+
+  Scenario Outline: Listing environment variables for a specific environment
+    When I run `ey-core environment_variables <Environment Flag> staging`
+    Then I see the environment variables associated with `staging` environment
+    But I do not see environment variables associated with any other environments different from `staging`
+
+    Examples:
+      | Environment Flag  |
+      | -e                |
+      | --environment     |
+
+  Scenario Outline: Listing environment variables for a specific application
+    When I run `ey-core environment_variables <Application Flag> blog_app`
+    Then I see the environment variables associated with `blog_app` application
+    But I do not see environment variables associated with any other applications different from `blog_app`
+
+    Examples:
+      | Application Flag  |
+      | -a                |
+      | --application     |
+

data/features/environments.feature

@@ -0,0 +1,30 @@
+Feature: Environments
+  In order to know what Engine Yard environments I can access
+  As a User
+  I want to be able to list the environments with which I'm associated
+
+  Background:
+    Given I'm an Engine Yard user
+    And ey-core is configured with my cloud token
+    And I have the following accounts:
+      | Account Name  |
+      | one           |
+      | two           |
+      | three         |
+    And each of my accounts has several applications
+    And each of my applications has an environment
+
+  Scenario: Listing all of my environments
+    When I run `ey-core environments`
+    Then I see the name and ID for all of my environments
+
+  Scenario Outline: Listing environments for a specific account
+    When I run `ey-core environments <Account Flag> one`
+    Then I see the environments in the one account
+    But I do not see environments from other accounts
+
+    Examples:
+      | Account Flag  |
+      | -a            |
+      | --account     |
+