rcloadenv 0.1.1 → 0.2.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 31510d7452b0e8c4709b51f140cd4c5986129e75
-  data.tar.gz: a6a203aef79daa98a74fdd48ade7559249e5fe71
+SHA256:
+  metadata.gz: 1cc4bb306ab969ea6a63f15e5fc9075df593306293f766d660f23a2ec9087dd0
+  data.tar.gz: feb5de2a2e1a2de5c08a0ce42c54d88496cf8a4d478a37ecbe980dbfa4bd7f98
 SHA512:
-  metadata.gz: e7469d40251b4d9cd965d503544c9a56d81dbebdccbb17b54b11cf67957ee917ff2f4eb11476740a20b3d025e3246c5f426b9cbced3ee73ad8d3c8c5368da735
-  data.tar.gz: e4949ed052f0dbe44877f3048f23e4fab92a96889c48bfdb5339ae97145dbd896b3f5aa881e18aaf5775ed8c5af3f8b2aeb1ffdac5f7cbfa89ae6954ee26b13f
+  metadata.gz: 9fdc21e25f7b66625cad77dbf9ad9872e1150728c07775e3d47b45ee2e57d9be83ade8f1fbe2d2c7d385e10ee4b1706e3fd398d9cc8cef32687a4f369f709ae0
+  data.tar.gz: a6aa807120a6ea3d0b449d7a6b9e2ae910324cabf5c1875076ec4fd484e867890d8f5f443a97cfb732dfa2cbbbbe44250a839a12cdb45455385a6a0dbef06e72

data/README.md

@@ -14,11 +14,27 @@ Install the gem using
 Alternately, include "rcloadenv" in your application's Gemfile.
 
 You may then invoke the "rcloadenv" binary. You must pass the name of the
-runtime config resource, and then the command to execute. For example, if
-the gem is present in the bundle for your Rails app, you can execute:
+runtime config resource, and then optionally a command to execute, delimited
+by two dashes `--`.
+
+If a command is provided, rcloadenv loads the configuration into environment
+variables and runs the command. For example, if the gem is present in the
+bundle for your Rails app, you can execute:
 
     bundle exec rcloadenv my-config -- bin/rails s
 
+to run Rails directly with the loaded environment.
+
+If a command is _not_ provided_, rcloadenv loads the configuration and prints
+it to stdout in dotenv-compatible format. For example, you can execute:
+
+    bundle exec rcloadenv my-config > .env
+
+to create a `.env` file suitable for loading with the
+[dotenv](https://github.com/bkeepers/dotenv/) gem.
+
+### Accessing runtime config data
+
 If `rcloadenv` is run on Google Cloud Platform hosting (such as Google Compute
 Engine, Container Engine, or App Engine), then it infers the project name and
 credentials from the hosting environment.
@@ -34,7 +50,7 @@ Run `rcloadenv --help` for more information on flags you can set.
 When not running on GCP, credentials are obtained from
 [Application Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials),
 so you can set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable or
-configure `gcloud auth`.
+configure `gcloud auth application-default login`.
 
 ## Example: Loading the Rails SECRET_KEY_BASE in Google App Engine
 

data/lib/rcloadenv/cli.rb

@@ -35,7 +35,7 @@ module RCLoadEnv
       @debug = false
 
       @parser = OptionParser.new do |opts|
-        opts.banner = "Usage: rcloadenv [options] <config-name> -- <command>"
+        opts.banner = "Usage: rcloadenv [options] <config-name> [-- <command>]"
         opts.on "-p name", "--project=name", "--projectId=name",
                 "Project to read runtime config from" do |p|
           @project = p
@@ -66,7 +66,7 @@ module RCLoadEnv
       end
 
       separator_index = args.index "--"
-      @command_list = separator_index ? args[(separator_index+1)..-1] : []
+      @command_list = separator_index ? args[(separator_index+1)..-1] : nil
 
       args = args[0..separator_index] if separator_index
       begin
@@ -82,8 +82,8 @@ module RCLoadEnv
         usage_error "Extra arguments found: #{remaining_args.inspect}"
       end
 
-      if @command_list.empty?
-        usage_error "You must provide a command delimited by `--`."
+      if @command_list && @command_list.empty?
+        usage_error "Command cannot be empty. To output dotenv format, omit `--`."
       end
     end
 
@@ -95,8 +95,12 @@ module RCLoadEnv
       loader = RCLoadEnv::Loader.new @config_name,
           exclude: @exclude, include: @include, override: @override,
           project: @project, debug: @debug
-      loader.modify_env ENV
-      exec(*@command_list)
+      if @command_list
+        loader.modify_env ENV
+        exec(*@command_list)
+      else
+        loader.write_dotenv
+      end
     end
 
     ## @private

data/lib/rcloadenv/loader.rb

@@ -13,6 +13,7 @@
 # limitations under the License.
 ;
 
+require "shellwords"
 require "rcloadenv/api_client"
 require "google/cloud/env"
 
@@ -72,7 +73,7 @@ module RCLoadEnv
           debug "Skipping config variable #{k}"
         else
           debug "Found config variable #{k}"
-          key = k.split("/").last.upcase.gsub("-", "_")
+          key = make_env_key k
           if !env.include?(key)
             debug "Setting envvar: #{key}"
             env[key] = v
@@ -88,7 +89,26 @@ module RCLoadEnv
     end
 
     ##
-    # Returns the has of variables retrieved from the runtime config.
+    # Modify the given environment with the configuration. The given hash
+    # is modified in place and returned. If no hash is provided, a new one is
+    # created and returned.
+    #
+    # @param [Hash<String,String>] env The environment to modify.
+    # @return the modified environment.
+    #
+    def write_dotenv io=STDOUT
+      raw_variables.each do |k, v|
+        key = make_env_key k
+        if key =~ /^[\w\.]+$/
+          io.puts "#{key}=\"#{escape_for_dotenv v}\""
+        else
+          error "Bad key: #{key}"
+        end
+      end
+    end
+
+    ##
+    # Returns the hash of variables retrieved from the runtime config.
     # Variable names have the parent (project and config name) stripped.
     # Values are all converted to strings.
     #
@@ -149,10 +169,25 @@ module RCLoadEnv
       s
     end
 
+    ## @private
+    def make_env_key key
+      key.split("/").last.upcase.gsub("-", "_")
+    end
+
+    ## @private
+    def escape_for_dotenv value
+      value.gsub("\\", "\\\\\\\\").gsub("\n", "\\\\n").gsub("$", "\\\\$")
+    end
+
     ## @private
     def debug str
       STDERR.puts "RCLOADENV DEBUG: #{str}" if @debug
     end
+
+    ## @private
+    def error str
+      STDERR.puts "RCLOADENV ERROR: #{str}"
+    end
   end
 
 end

data/lib/rcloadenv/version.rb

@@ -16,6 +16,6 @@
 module RCLoadEnv
 
   ## The current version of this gem, as a string.
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0.pre.1'.freeze
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcloadenv
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0.pre.1
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-11 00:00:00.000000000 Z
+date: 2017-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-api-client
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 description: rcloadenv is a tool for loading configuration from the Google Runtime
   Config API into environment variables. The rcloadenv ruby gem is a ruby implementation
   of the tool that may be installed as a ruby gem or included in a ruby Gemfile.
@@ -161,12 +175,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Load Google Runtime Config data into environment variables