ey-core 3.6.4 → 3.6.5

data/README.md

@@ -1,135 +1,135 @@
-# Ey::Core #
-
-Official Engine Yard Core API Ruby client and CLI utility.
-
-## Installation ##
-
-Add this line to your application's Gemfile:
-
-    gem 'ey-core'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself for ad-hoc or CLI usage:
-
-    $ gem install ey-core
-
-## 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.
-
-```ruby
-client.users.current  # =>
-<Ey::Core::Client::User
-  id="0037000000uLmCe",
-  name="Josh Lane",
-  email="jlane@engineyard.com",
-  accounts_url="https://api.engineyard.com/users/0037000000uLmCe/accounts"
->
-```
-
-#### Authentication ####
-
-* Via Token
-
-```ruby
-Ey::Core::Client.new(token: "943662ea7d0fad349eeae9f69adb521d")
-```
-
-* Via HMAC
-
-```ruby
-Ey::Core::Client.new(
-  :auth_id  => "943662ea7d0fad",
-  :auth_key => "943662ea7d0fad349eeae9f69adb521d",
-  :logger   => Logger.new(STDOUT),
-)
-```
-
-#### Mock ####
-
-Mock is disabled by default.
-
-```ruby
-Ey::Core::Client.mocking? # => false
-Ey::Core::Client.mock!
-Ey::Core::Client.mocking? # => true
-```
-
-Reset the mock
-
-```ruby
-Ey::Core::Client.reset!
-```
-
-#### 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`
-
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+# Ey::Core #
+
+Official Engine Yard Core API Ruby client and CLI utility.
+
+## Installation ##
+
+Add this line to your application's Gemfile:
+
+    gem 'ey-core'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself for ad-hoc or CLI usage:
+
+    $ gem install ey-core
+
+## 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.
+
+```ruby
+client.users.current  # =>
+<Ey::Core::Client::User
+  id="0037000000uLmCe",
+  name="Josh Lane",
+  email="jlane@engineyard.com",
+  accounts_url="https://api.engineyard.com/users/0037000000uLmCe/accounts"
+>
+```
+
+#### Authentication ####
+
+* Via Token
+
+```ruby
+Ey::Core::Client.new(token: "943662ea7d0fad349eeae9f69adb521d")
+```
+
+* Via HMAC
+
+```ruby
+Ey::Core::Client.new(
+  :auth_id  => "943662ea7d0fad",
+  :auth_key => "943662ea7d0fad349eeae9f69adb521d",
+  :logger   => Logger.new(STDOUT),
+)
+```
+
+#### Mock ####
+
+Mock is disabled by default.
+
+```ruby
+Ey::Core::Client.mocking? # => false
+Ey::Core::Client.mock!
+Ey::Core::Client.mocking? # => true
+```
+
+Reset the mock
+
+```ruby
+Ey::Core::Client.reset!
+```
+
+#### 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`
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,18 +1,18 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
-require 'cucumber/rake/task'
-
-namespace :spec do
-  task :mocked do
-    sh "env MOCK_CORE=true bundle exec rspec spec/"
-  end
-  task :unmocked do
-    sh "env MOCK_CORE=false CORE_URL=http://api-development.localdev.engineyard.com:9292 bundle exec rspec spec/"
-  end
-end
-
-task :spec => ["spec:mocked", "spec:unmocked"]
-
-Cucumber::Rake::Task.new
-
-task default: ["spec:mocked", :cucumber]
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'cucumber/rake/task'
+
+namespace :spec do
+  task :mocked do
+    sh "env MOCK_CORE=true bundle exec rspec spec/"
+  end
+  task :unmocked do
+    sh "env MOCK_CORE=false CORE_URL=http://api-development.localdev.engineyard.com:9292 bundle exec rspec spec/"
+  end
+end
+
+task :spec => ["spec:mocked", "spec:unmocked"]
+
+Cucumber::Rake::Task.new
+
+task default: ["spec:mocked", :cucumber]

data/bin/ey-core

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../lib/ey-core/cli/main', __FILE__)
-
-Ey::Core::Cli::Main.new(ARGV).execute!
+#!/usr/bin/env ruby
+require File.expand_path('../../lib/ey-core/cli/main', __FILE__)
+
+Ey::Core::Cli::Main.new(ARGV).execute!

data/docs/development.md

@@ -0,0 +1,6 @@
+### Bundle ey-core locally
+1. Modify `lib/ey-core/version.rb` to next minor version
+2. Run `gem build ey-core.gemspec`
+3. Run `gem install ./ey-core-<version>.gem`
+4. Run `ey-core` and your latest update would be reflected
+5. To cross check ey-core version locally, run `gem list | grep ey-core`, and you would see your version listed

data/examples/add_instance.rb

@@ -1,74 +1,74 @@
-#!/usr/bin/env ruby
-
-# Very basic example of how to add an instance to a given environment.
-# As is attempts to add a t2.micro, see new_server_specs below.
-# For more info visit http://developer.engineyard.com
-
-require 'ey-core'
-require 'optparse'
-require 'yaml'
-
-options = {}
-OptionParser.new do |opts|
-  opts.banner = "Usage: add_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('-r', '--irole ROLE', 'Instance role (app, util)') { |v| options[:instance_role] = 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])
-
-# Instance's name
-instance_name = options[:instance_name]
-
-puts "Adding app instance #{instance_name} to environment #{environment.name}...."
-
-# TO DO:  read new_server_specs from a file provided as a parameter
-new_server_specs = {
-        :environment     => environment.id,
-        :flavor_id       => "t2_micro",
-        :mnt_volume_size => "10",
-        :name            => instance_name,
-        :role            => options[:instance_role],
-        :volume_size     => "10",
-}
-
-provision_request = client.servers.create!(new_server_specs)
-
-# Provisioning the instance with a timeout of 1200sec.
-# Adjust as necessary depending of the type/role of instance.
-provision_request.ready!(1200)
-
-ap provision_request.attributes
-
-puts "Instance provisioned successfully"
-puts "-------------------"
-
-puts "Waiting for instance #{instance_name} to integrate into the environment #{environment.name}...."
-new_server = provision_request.resource!
-
-new_server.wait_for(1800) { |s| s.state == "running" || s.state == "error" }
-
-if !new_server.enabled? then
-  puts "Adding of instance #{instance_name} into environment #{environment.name} FAILED!!!"
-  puts "Check cloud.engineyard.com for more details"
-  ap new_server.attributes
-  exit
-end
-
-puts "Adding of instance #{instance_name} into environment #{environment.name} SUCCEEDED!!!"
-
-
-
+#!/usr/bin/env ruby
+
+# Very basic example of how to add an instance to a given environment.
+# As is attempts to add a t2.micro, see new_server_specs below.
+# For more info visit http://developer.engineyard.com
+
+require 'ey-core'
+require 'optparse'
+require 'yaml'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: add_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('-r', '--irole ROLE', 'Instance role (app, util)') { |v| options[:instance_role] = 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])
+
+# Instance's name
+instance_name = options[:instance_name]
+
+puts "Adding app instance #{instance_name} to environment #{environment.name}...."
+
+# TO DO:  read new_server_specs from a file provided as a parameter
+new_server_specs = {
+        :environment     => environment.id,
+        :flavor_id       => "t2_micro",
+        :mnt_volume_size => "10",
+        :name            => instance_name,
+        :role            => options[:instance_role],
+        :volume_size     => "10",
+}
+
+provision_request = client.servers.create!(new_server_specs)
+
+# Provisioning the instance with a timeout of 1200sec.
+# Adjust as necessary depending of the type/role of instance.
+provision_request.ready!(1200)
+
+ap provision_request.attributes
+
+puts "Instance provisioned successfully"
+puts "-------------------"
+
+puts "Waiting for instance #{instance_name} to integrate into the environment #{environment.name}...."
+new_server = provision_request.resource!
+
+new_server.wait_for(1800) { |s| s.state == "running" || s.state == "error" }
+
+if !new_server.enabled? then
+  puts "Adding of instance #{instance_name} into environment #{environment.name} FAILED!!!"
+  puts "Check cloud.engineyard.com for more details"
+  ap new_server.attributes
+  exit
+end
+
+puts "Adding of instance #{instance_name} into environment #{environment.name} SUCCEEDED!!!"
+
+
+

data/examples/boot_env.rb

@@ -1,60 +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!!!"
+#!/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

@@ -1,14 +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)
-
+## 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)
+