elastic_beans 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70a69de3c656c7d828c6b47684f3806a8bfb54dc
-  data.tar.gz: 5e257058d7649f152d69964d6ff9c5cfcfe5c3e4
+  metadata.gz: df2c92db9341aafe114e311aa9513e262980075b
+  data.tar.gz: e0d1656e123cc87594923df2a454692c6a5f24cb
 SHA512:
-  metadata.gz: c7f8b3ed1abc7fc073ca31cd1fa876c30081ac3365f3318e3add6631ef5740389b6a22a60ac6fa73cad3cfb2c85c28977350e7772a05484338983c06c5f28608
-  data.tar.gz: e0a78ebe606867f4dd9845f3bf5bbb476588ff2571d99f2aa7cf9f5ff6c82a1f536b10adb7ee03a15718cb907745cf4379b7d914aed7cd621e298c25fabee595
+  metadata.gz: c71f8da1510349c373e03fa299d6106bd7b932168cfd166c797f21311442b5e34431bc817ef39063f1969d1f22b56b8865ed919a9de7968ef1190e8bebe86003
+  data.tar.gz: 2834984b88ad858571e1f01681c5b2bc41d388635c096a84bff9bdf3ba380551dbf00b7bc00072029c98f137911704f985c285ddb4eaf169311a2293c5826769

data/README.md

@@ -5,18 +5,22 @@ It is a CLI that replaces the [Elastic Beanstalk CLI][eb], which looks great on
 
 * The VPC support in `eb create` is great, but it ends there. Connecting to instances inside a VPC requires manual SSH gateway setup.
 * The CLI [supports multiple environments][eb-compose], but only in a rigid fashion that isn't usable when those environments share the same codebase.
+* Upgrading running applications to a new version of the platform should be easy with `eb upgrade`, but using a custom AMI to support on-disk encryption means that command can't be used.
 
 [eb]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3.html
 [eb-compose]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/ebcli-compose.html
 
 ## Usage
 
+See [the Getting Started guide][getting-started] for a complete tutorial on setting up your AWS account.
+
 Elastic Beans makes heavy use of the [AWS SDK][aws-sdk].
 Configuration of AWS credentials and region should be completed before using this gem, according to [the SDK configuration instructions][configuration].
 As the SDK documentation suggests, using environment variables is recommended.
 
 [aws-sdk]: https://aws.amazon.com/sdk-for-ruby/
 [configuration]: http://docs.aws.amazon.com/sdk-for-ruby/latest/DeveloperGuide/aws-ruby-sdk-getting-started.html#aws-ruby-sdk-configuration
+[getting-started]: https://github.com/onemedical/elastic_beans/wiki/Getting-started
 
     # Pre-configure the application before creating environments
     beans configure -n myapp-networking -a myapp \
@@ -295,6 +299,14 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ### Philosophy
 
+beans is an opinionated but flexible tool.
+It is written for Rails applications and can make assumptions based on that.
+Additionally, it assumes your application was set up by beans and will not handle one set up by hand very well.
+During setup it will configure your application to meet the best-practice criteria for a HIPAA-compliant Rails application.
+However, it will assume future customization is permanent and attempt not to override your choices.
+
+Whenever possible, operations are idempotent.
+
 Elastic Beanstalk is an evolving platform, albeit slowly.
 It has many gaps and surprises in functionality that beans addresses.
 Whenever possible, beans adds behavior using publicized and approved methods, such as `commands` in an ebextension.

data/lib/elastic_beans/cli.rb

@@ -101,6 +101,21 @@ class ElasticBeans::CLI < Thor
     error(e)
   end
 
+  desc ElasticBeans::Command::GetEnv::USAGE, ElasticBeans::Command::GetEnv::DESC
+  long_desc ElasticBeans::Command::GetEnv::LONG_DESC
+  option :application, aliases: %w(-a), required: true, desc: APPLICATION_DESC
+  def getenv(*env_vars)
+    @verbose = options[:verbose]
+    ElasticBeans::Command::GetEnv.new(
+      application: application(
+        name: options[:application],
+      ),
+      ui: ui,
+    ).run(*env_vars)
+  rescue StandardError => e
+    error(e)
+  end
+
   desc ElasticBeans::Command::Scale::USAGE, ElasticBeans::Command::Scale::DESC
   long_desc ElasticBeans::Command::Scale::LONG_DESC
   option :application, aliases: %w(-a), required: true, desc: APPLICATION_DESC

data/lib/elastic_beans/command/get_env.rb

@@ -0,0 +1,35 @@
+module ElasticBeans
+  module Command
+    # :nodoc: all
+    class GetEnv
+      USAGE = "getenv [KEY]..."
+      DESC = "Fetch environment variables from the Elastic Beanstalk application"
+      LONG_DESC = <<-LONG_DESC
+Fetch environment variables from the Elastic Beanstalk application.
+These are stored in S3 to avoid the 4096-byte limit on environment variables in Elastic Beanstalk.
+
+Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
+      LONG_DESC
+
+      def initialize(application:, ui:)
+        @application = application
+        @ui = ui
+      end
+
+      def run(*env_vars)
+        outputs = application.env_vars.to_h.each_with_object([]) do |(key, value), acc|
+          if env_vars.empty? || env_vars.include?(key)
+            acc << "#{key}=#{value}"
+          end
+        end
+        outputs.sort.each do |output|
+          ui.info(output)
+        end
+      end
+
+      private
+
+      attr_reader :application, :ui
+    end
+  end
+end

data/lib/elastic_beans/command.rb

@@ -2,6 +2,7 @@ require "elastic_beans/command/configure"
 require "elastic_beans/command/create"
 require "elastic_beans/command/deploy"
 require "elastic_beans/command/exec"
+require "elastic_beans/command/get_env"
 require "elastic_beans/command/scale"
 require "elastic_beans/command/set_env"
 require "elastic_beans/command/talk"

data/lib/elastic_beans/env_vars.rb

@@ -16,9 +16,20 @@ module ElasticBeans
       @s3_key ||= "#{application.name}/env_vars.json"
     end
 
+    def to_h
+      s3.head_object(bucket: application.bucket_name, key: s3_key)
+      response = s3.get_object(bucket: application.bucket_name, key: s3_key)
+      existing_script = response.body.read
+      JSON.parse(existing_script)
+    rescue ::Aws::S3::Errors::NotFound
+      {}
+    rescue ::Aws::S3::Errors::Forbidden
+      raise CannotAccessConfigError.new(bucket_name: application.bucket_name, key: s3_key)
+    end
+
     # Updates the environment variables stored in S3 by merging it with the given +env_hash+.
     def update(env_hash)
-      body = env_script(existing_env_hash.merge(env_hash))
+      body = env_script(to_h.merge(env_hash))
       s3.put_object(bucket: application.bucket_name, key: s3_key, body: body)
     end
 
@@ -30,17 +41,6 @@ module ElasticBeans
       JSON.dump(env_hash)
     end
 
-    def existing_env_hash
-      s3.head_object(bucket: application.bucket_name, key: s3_key)
-      response = s3.get_object(bucket: application.bucket_name, key: s3_key)
-      existing_script = response.body.read
-      JSON.parse(existing_script)
-    rescue ::Aws::S3::Errors::NotFound
-      {}
-    rescue ::Aws::S3::Errors::Forbidden
-      raise CannotAccessConfigError.new(bucket_name: application.bucket_name, key: s3_key)
-    end
-
     # :nodoc: all
     # @!visibility private
     class CannotAccessConfigError < ElasticBeans::Error

data/lib/elastic_beans/version.rb

@@ -1,3 +1,3 @@
 module ElasticBeans
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic_beans
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Adam Stegman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-16 00:00:00.000000000 Z
+date: 2016-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -167,6 +167,7 @@ files:
 - lib/elastic_beans/command/create.rb
 - lib/elastic_beans/command/deploy.rb
 - lib/elastic_beans/command/exec.rb
+- lib/elastic_beans/command/get_env.rb
 - lib/elastic_beans/command/scale.rb
 - lib/elastic_beans/command/set_env.rb
 - lib/elastic_beans/command/talk.rb
@@ -216,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Elastic Beanstalk environment orchestration for a Rails app