rcloadenv 0.0.1.rc1

data/lib/rcloadenv/loader.rb

@@ -0,0 +1,158 @@
+# Copyright 2017 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+;
+
+require "rcloadenv/api_client"
+require "google/cloud/env"
+
+module RCLoadEnv
+
+  ##
+  # A class that loads environment variables from a RuntimeConfig resource.
+  #
+  class Loader
+
+    ##
+    # Error thrown when inputs are malformed.
+    #
+    class UsageError < StandardError
+    end
+
+    ##
+    # Create a loader. Alwaus uses application default credentials.
+    #
+    # @param [String] config_name Name of the runtime config resource
+    # @param [Array<String>] exclude Config keys to exclude (optional)
+    # @param [Array<String>] include Config keys to include (optional)
+    # @param [Boolean] override Whether to override existing environment
+    #     variables (default: false)
+    # @param [String,nil] project Optional name of the cloud project. If not
+    #     set, attempts to infer one from the environment.
+    # @param [Boolean] debug Whether to print debug output (default: false)
+    #
+    def initialize config_name,
+                   exclude: [], include: [], override: false,
+                   project: nil, debug: false
+      @config_name = config_name.to_s
+      @project = (project || default_project).to_s
+      @exclude = exclude
+      @include = include
+      @override = override
+      @debug = debug
+    end
+
+    ## @return [String] The Runtime Config resource name
+    attr_reader :config_name
+    ## @return [String] The cloud project
+    attr_reader :project
+
+    ##
+    # 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 modify_env env={}
+      raw_variables.each do |k, v|
+        if !@exclude.empty? && @exclude.include?(k) ||
+           !@include.empty? && !@include.include?(k)
+          debug "Skipping config variable #{k}"
+        else
+          debug "Found config variable #{k}"
+          key = k.split("/").last.upcase.gsub("-", "_")
+          if !env.include?(key)
+            debug "Setting envvar: #{key}"
+            env[key] = v
+          elsif @override
+            debug "Overriding envvar: #{key}"
+            env[key] = v
+          else
+            debug "Envvar already set: #{key}"
+          end
+        end
+      end
+      env
+    end
+
+    ##
+    # Returns the has of variables retrieved from the runtime config.
+    # Variable names have the parent (project and config name) stripped.
+    # Values are all converted to strings.
+    #
+    # @return [Hash<String,String>] the variables.
+    #
+    def raw_variables
+      @raw_variables ||= load_raw_variables
+    end
+
+    ## @private
+    def service
+      @service ||= create_service
+    end
+
+    ## @private Used to mock the service for testing
+    def service= mock
+      @service = mock
+    end
+
+    ## @private
+    def load_raw_variables
+      if project.empty?
+        raise UsageError, "Project name must be provided."
+      end
+      if config_name.empty?
+        raise UsageError, "Config name must be provided."
+      end
+      parent_path = "projects/#{project}/configs/#{config_name}"
+      debug "Loading #{config_name} from project #{project}"
+      response = service.list_project_config_variables \
+        parent_path, return_values: true
+      raw_variables = {}
+      (response.to_h[:variables] || []).each do |var_info|
+        key = var_info[:name].sub "#{parent_path}/variables/", ""
+        raw_variables[key] = var_info[:text] || var_info[:value]
+      end
+      raw_variables
+    end
+
+    ## @private
+    def default_project
+      ENV["GOOGLE_CLOUD_PROJECT"] ||
+        ENV["GCLOUD_PROJECT"] ||
+        Google::Cloud.env.project_id ||
+        `gcloud config get-value project 2>/dev/null`.strip
+    end
+
+    ## @private
+    def create_service
+      s = Google::Apis::RuntimeconfigV1beta1::CloudRuntimeConfigService.new
+      s.client_options.application_name = "rcloadenv-ruby"
+      s.client_options.application_version = RCLoadEnv::VERSION
+      s.request_options.retries = 3
+      s.request_options.header ||= {}
+      s.request_options.header["x-goog-api-client"] = \
+        "gl-ruby/#{RUBY_VERSION} rcloadenv/#{RCLoadEnv::VERSION}"
+      s.authorization = RCLoadEnv::Credentials.default.client
+      s
+    end
+
+    ## @private
+    def debug str
+      STDERR.puts "RCLOADENV DEBUG: #{str}" if @debug
+    end
+  end
+
+end

data/lib/rcloadenv/version.rb

@@ -0,0 +1,21 @@
+# Copyright 2017 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+;
+
+module RCLoadEnv
+
+  ## The current version of this gem, as a string.
+  VERSION = '0.0.1.rc1'.freeze
+
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: rcloadenv
+version: !ruby/object:Gem::Version
+  version: 0.0.1.rc1
+platform: ruby
+authors:
+- Daniel Azuma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-env
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+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.
+email:
+- dazuma@gmail.com
+executables:
+- rcloadenv
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- README.md
+- bin/rcloadenv
+- lib/rcloadenv.rb
+- lib/rcloadenv/api_client.rb
+- lib/rcloadenv/cli.rb
+- lib/rcloadenv/credentials.rb
+- lib/rcloadenv/google/apis/runtimeconfig_v1beta1.rb
+- lib/rcloadenv/google/apis/runtimeconfig_v1beta1/classes.rb
+- lib/rcloadenv/google/apis/runtimeconfig_v1beta1/representations.rb
+- lib/rcloadenv/google/apis/runtimeconfig_v1beta1/service.rb
+- lib/rcloadenv/loader.rb
+- lib/rcloadenv/version.rb
+homepage: https://github.com/GoogleCloudPlatform/rcloadenv
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Load Google Runtime Config data into environment variables
+test_files: []