ey-core 3.4.0 → 3.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1666dc7dd164cf3aa06869572f6d663c3c7108ec
-  data.tar.gz: eba158a6d0bbd66c885d3a5e38569e50ad70899c
+SHA256:
+  metadata.gz: e7cd69781a4eb3275ce1a1326c7ea79279dcff1c6de8a663d95e0276d318e36e
+  data.tar.gz: e60e683abec4d85850bf11d7368c3ec501cd9c4d96af07ed5fc6613988fe4f69
 SHA512:
-  metadata.gz: df68df0484a849dafc7726e6e0ebafbc96d2aca30e3de1e9aae32fb04baf035bbcc70c5fffd25d5fab4f9c7e49231b32f8f365d6827bd41d9dadb90ccbce283a
-  data.tar.gz: 77d5890272ca1fe4c2b248a945dae39efffbb64e1293bd2338e3bffd35864580d6c5952d014612abb21a1443ef594b1a455cd8424b576326e8d948d96dd76c28
+  metadata.gz: d8d9bf7f44d69e2de4a71d393aa29e6e88cc851ebd99177c091388975bbe006d2cf4f9ccde6ab7d291dc200cbac0c26aa57ec96ba7322a5386e83d49df76a567
+  data.tar.gz: bbf84bfa83d24a4f293c14b928614b68846d988a30835d2973251f2a5caf6c85ad49703c1dc12b3e2e1478fec01003d9a14d8057f6a1f03ecf43e7ed93dc947f

data/.ruby-version

@@ -1 +1 @@
-1.9.3
+2.5.8

data/.travis.yml

@@ -15,6 +15,7 @@ cache: bundler
 rvm:
   - 2.2.2
   - 2.3.1
+  - 2.4.2
 
 env:
   - COVERAGE=true

data/CHANGELOG.md

@@ -1,13 +1,35 @@
 # Change Log
 
-## [Unreleased](https://github.com/engineyard/core-client-rb/tree/HEAD)
+## [Unreleased](https://github.com/engineyard/core-client-rb/tree/develop)
 
-[Full Changelog](https://github.com/engineyard/core-client-rb/compare/v2.8.4...HEAD)
+[Full Changelog](https://github.com/engineyard/core-client-rb/compare/v3.6.1...develop)
 
 **Merged pull requests:**
 
-- \[ENG-193\] Create untracked addresses via smithy [\#34](https://github.com/engineyard/core-client-rb/pull/34) ([omgitsads](https://github.com/omgitsads))
-- remove usage of hmac client in specs [\#33](https://github.com/engineyard/core-client-rb/pull/33) ([lanej](https://github.com/lanej))
+## [v3.6.1](https://github.com/engineyard/core-client-rb/tree/v3.6.1) (2020-06-11)
+
+[Full Changelog](https://github.com/engineyard/core-client-rb/compare/v3.5.0...v3.6.1)
+
+**Merged pull requests:**
+
+- Adds support for Docker credentials [\#106](https://github.com/engineyard/core-client-rb/pull/106) ([nodecarter](https://github.com/nodecarter))
+- Adds support for container discovery [\#107](https://github.com/engineyard/core-client-rb/pull/107) ([thorn](https://github.com/thorn))
+- Fixes `get_deployment` request parameters [\#108](https://github.com/engineyard/core-client-rb/pull/108) ([lucis-fluxum](https://github.com/lucis-fluxum))
+- Adds server names to server list output [\#112](https://github.com/engineyard/core-client-rb/pull/112) ([glennr](https://github.com/glennr))
+- Fixes the `--no-migrate` flag for `ey-core deploy` [\#114](https://github.com/engineyard/core-client-rb/pull/114) ([mushyy](https://github.com/mushyy))
+- Upgrades dependencies and adds ruby-2.7 support for the gem [\#120](https://github.com/engineyard/core-client-rb/pull/120) ([ssuttner](https://github.com/ssuttner))
+- Adds a bit of CLI documentation [\#121](https://github.com/engineyard/core-client-rb/pull/121) ([ess](https://github.com/ess))
+
+## [v3.5.0](https://github.com/engineyard/core-client-rb/tree/v3.5.0) (2018-04-04)
+[Full Changelog](https://github.com/engineyard/core-client-rb/compare/v3.4.4...v3.5.0)
+
+**Merged pull requests:**
+
+- Add support for autoscaling policies [\#110](https://github.com/engineyard/core-client-rb/pull/101) ([thorn](https://github.com/thorn))
+- Add support for environment variables [\#90](https://github.com/engineyard/core-client-rb/pull/90) ([rzaharenkov](https://github.com/rzaharenkov))
+- Add ability to send configuration options together with blueprint [\#104](https://github.com/engineyard/core-client-rb/pull/104) ([ramonpm](https://github.com/ramonpm))
+- Add support for address.scope parameter for EIP [\#102](https://github.com/engineyard/core-client-rb/pull/102) ([thorn](https://github.com/thorn))
+- Various fixes for `servers` command [\#103](https://github.com/engineyard/core-client-rb/pull/103) ([binarypaladin](https://github.com/binarypaladin))
 
 ## [v2.8.4](https://github.com/engineyard/core-client-rb/tree/v2.8.4) (2015-08-12)
 [Full Changelog](https://github.com/engineyard/core-client-rb/compare/v2.8.3...v2.8.4)
@@ -164,4 +186,4 @@
 
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile

@@ -13,7 +13,6 @@ end
 group :test do
   gem 'codeclimate-test-reporter', '~> 0.3'
   gem 'faker'
-  gem 'hashie'
   gem 'rack-test'
   gem 'rspec', '~> 3.1'
   gem 'simplecov'

data/README.md

@@ -1,8 +1,8 @@
-# Ey::Core
+# Ey::Core #
 
-Official Ruby Engine Yard Core API Client.
+Official Engine Yard Core API Ruby client and CLI utility.
 
-## Installation
+## Installation ##
 
 Add this line to your application's Gemfile:
 
@@ -12,11 +12,68 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it yourself for ad-hoc or CLI usage:
 
     $ gem install ey-core
 
-## Usage
+## Usage ##
+
+There are two ways to use this gem: you can install it to use as a client library for writing your own Engine Yard Cloud integrations, or you can use the `ey-core` CLi app to use our curated integrations.
+
+### CLI Usage ###
+
+The CLI app, `ey-core`, is the replacement for the `ey` command that was provided by the now mostly deprecated`engineyard` gem. The old gem is still updated as need be, but is effectively just a slightly different UI for the `ey-core` command.
+Like the `git` command, `ey-core` is like a gateway to other commands.
+
+Rather than attempting to provide an exhaustive writeup of all of the commands provided by `ey-core`, this document will instead describe what are likely the most common use cases and leave you to read up on the remainder via the `help` command.
+
+#### Use Case: Getting Help ####
+
+Arguably the most important command in the app is `ey-core help`. Given no arguments, it provides the list of second-level commands avaiable for use. From that point, each argument is expected to be a command from the next level of the hierarchy.
+
+For example, if one wishes to learn about the `servers` second-level command, they would do `ey-core help servers`.
+
+For commands in even deeper levels, one just adds each level of chain after the `help` command. Try this in your terminal: `ey-core help recipes apply`
+
+#### Use Case: Deploying An App ####
+
+The `ey-core deploy` command allows one to deploy a new revision of an existing application in an existing environment. The command itself has several options, some of which may or may not be required depending on several factors. To guarantee the best result and remove a good deal of uncertainty in the process, we've opted to describe a somewhat verbose invocation of the command in this document.
+
+Let's start with some assumptions:
+
+* The name of our Engine Yard account is `MyAwesomeCompany` (you can get a real account name with `ey-core accounts`)
+* That account has an environment named `awesome_production` (you can get a real environment name with `ey-core environments`)
+* That account has an application named `awesome_app` (you can get a real application name with `ey-core applications`)
+* The aforementioned application is already associated with the environment
+
+As mentioned, some of the options for the `deploy` command are optional, and all of the topics discussed in our assumptions are effectively optional. That said, we suggest specifying *all* of these options to ensure absolutely that the proper application is deployed to the proper environment in the proper account.
+
+All that said, to deploy the application to its latest git ref and the same migration command as the last deployment, you would issue the following command:
+
+`$ ey-core deploy --account MyAwesomeCompany --environment awesome_production --app awesome_app`
+
+You can also specify a git ref to use if you'd like to deploy a specific version or branch of the app:
+
+`$ ey-core deploy --account MyAwesomeCompany --environment awesome_production --app awesome_app --ref feature/new-ui`
+
+Say that you want to change the way your migrations are run during the deploy. You can specify the migration command:
+
+`$ ey-core deploy --account MyAwesomeCompany --environment awesome_production --app awesome_app --migrate 'bundle exec rake db:migrate:new_hotness'`
+
+Additionally, if you wish to skip migrations for the deployment, you can do that, too:
+
+`$ ey-core deploy --account MyAwesomeCompany --environment awesome_production --app awesome_app --no-migrate`
+
+Any of the invocations that we've talked about so far will stream the deployment log as it runs. If you'd rather do a fire-and-forget style deployment and check in on it later, you can add the `--no-wait` flag. If, however, you'd like to see even more information spit out during the deploy, you can add the `--verbose` flag.
+
+That's about all there is to deployment so long as you consider the application, environment, and account to be required options. You can read more about any of the commands that we've mentioned in this use case by running the following in your terminal:
+
+* `ey-core help accounts`
+* `ey-core help applications`
+* `ey-core help deploy`
+* `ey-core help environments`
+
+### Client Library Usage ###
 
 Uses [cistern](https://github.com/lanej/cistern) to wrap RESTful resources nicely.
 
@@ -30,7 +87,7 @@ client.users.current  # =>
 >
 ```
 
-### Authentication
+#### Authentication ####
 
 * Via Token
 
@@ -48,7 +105,7 @@ Ey::Core::Client.new(
 )
 ```
 
-### Mock
+#### Mock ####
 
 Mock is disabled by default.
 
@@ -64,7 +121,7 @@ Reset the mock
 Ey::Core::Client.reset!
 ```
 
-### Testing
+#### Testing ####
 
 By default, specs are run against the core mock. In order to run them against awsm mocked mode instead, run `MOCK_CORE=false bundle exec rspec`
 

data/Rakefile

@@ -1,5 +1,6 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'cucumber/rake/task'
 
 namespace :spec do
   task :mocked do
@@ -12,4 +13,6 @@ end
 
 task :spec => ["spec:mocked", "spec:unmocked"]
 
-task default: "spec:mocked"
+Cucumber::Rake::Task.new
+
+task default: ["spec:mocked", :cucumber]

data/ey-core.gemspec

@@ -18,22 +18,23 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.licenses      = ["MIT"]
 
-  gem.required_ruby_version = ">= 2.2.2"
+  gem.required_ruby_version = ">= 2.5"
 
   gem.add_dependency "addressable"
 
-  gem.add_dependency "awesome_print"
+  gem.add_dependency "amazing_print", "~> 1.1.0"
   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 "hashie", "~> 4.1.0"
+  gem.add_dependency "faraday", "~> 1.0.1"
+  gem.add_dependency "faraday_middleware", "~> 1.0.0"
   gem.add_dependency "rack"
   gem.add_dependency "faye"
   gem.add_dependency "highline"
-  gem.add_dependency "json", "< 2.0"
+  gem.add_dependency "json", "~> 2.3.0"
   gem.add_dependency "mime-types"
   gem.add_dependency "oj"
   gem.add_dependency "oj_mimic_json"
@@ -45,4 +46,7 @@ Gem::Specification.new do |gem|
   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     |
+

data/features/init.feature

@@ -0,0 +1,6 @@
+Feature: Init
+  This command is deprecated
+
+  Scenario: Running init
+    When I run `ey-core init`
+    Then I am advised that this command has been deprecated

data/features/login.feature

@@ -0,0 +1,6 @@
+Feature: Login
+  In order to interact with Engine Yard Cloud
+  As a User
+  I want to be able to log into the Cloud API
+
+

data/features/scp.feature

@@ -0,0 +1,6 @@
+Feature: Scp
+  This command is deprecated
+
+  Scenario: Running init
+    When I run `ey-core init`
+    Then I am advised that this command has been deprecated

data/features/step_definitions/accounts_steps.rb

@@ -0,0 +1,37 @@
+Given %(I'm an Engine Yard user) do
+  memorize_fact(:me, create_user(client: client))
+  true
+end
+
+Given %(ey-core is configured with my cloud token) do
+  add_config_option(
+    'https://api.engineyard.com/' => current_user_hash['token']
+  )
+end
+
+Given %(I'm associated with several accounts) do
+  account1 = create_account(client: client, owner: current_user)
+  account2 = create_account(client: client, owner: current_user)
+  memorize_fact(:accounts, [account1, account2])
+end
+
+Given %r(^I have the following accounts:$) do |account_names|
+  account_names.hashes.each do |account_hash|
+    known_accounts.push(
+      create_account(
+        client: client,
+        owner: current_user,
+        account: {
+          name: account_hash['Account Name']
+        }
+      )
+    )
+  end
+end
+
+Then %(I see the name and ID of each of my accounts) do
+  recall_fact(:accounts).each do |account|
+    expect(output_text).to include(account.id)
+    expect(output_text).to include(account.name)
+  end
+end