doppler-env 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 893704f04dbd20ba4c775a8ebe6b7dea5f55105fd7a8bf906c9029011f0c096a
+  data.tar.gz: 15ec07069155d0e97a9e2f7d9221c57e4b84e8e411cbe71b6f88526daffd1a5b
+SHA512:
+  metadata.gz: 920874a6b0ada6aa3274954fdcb0225dca17ede31a0999434fbc457d193411b23b7d3c0e0cc0660e042477e32f373698eceee5daa06afd769fc92dd1a9a9d7b1
+  data.tar.gz: 7705aed9459ed35d13ab695975b688730317852bb87889044c4a2502a75cf17fa801c2ef8c9fa1a40103e6320975103d582d1575859b67d2967763cc272508da

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0 (Aug 4, 2022)
+
+- Initial release

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

data/README.md

@@ -0,0 +1,110 @@
+# doppler-env
+
+The doppler-env gem automates the injection of Doppler secrets as environment variables into any Ruby application and works in the terminal, RubyMine, and Visual Studio Code.
+
+**NOTE: This is not meant to be used in production deployments. For production deployments, we recommend using our [Integrations](https://docs.doppler.com/docs/integrations) or our standard run methods for [Docker](https://docs.doppler.com/docs/dockerfile) and [CLI](https://docs.doppler.com/docs/cli).**
+
+## Motivation
+
+The Doppler CLI provides the easiest method of injecting secrets into your application:
+
+```sh
+doppler run -- ruby app.rb
+```
+
+But when debugging with RubyMine or Visual Studio Code, a vendor-specific Ruby entry-point is used, preventing the Doppler CLI from acting as the application runner. At Doppler, we go to great lengths to [prevent secrets ending up on developer's machines](https://blog.doppler.com/how-to-prevent-secrets-from-ending-up-on-developers-machines) so downloading secrets to a .env file wasn't an option.
+
+You can replicate dotenv gem behavior by requiring doppler-env in your project to inject Doppler secrets.
+
+## Setup
+
+Ensure you have [installed the Doppler CLI](https://docs.doppler.com/docs/enclave-installation) locally and have [created a Doppler Project](https://docs.doppler.com/docs/create-project). Then authorize the Doppler CLI to retrieve secrets from your workplace by running:
+
+```sh
+doppler login
+```
+
+Then add `doppler-env` to your Bundler `Gemfile`:
+
+```ruby
+gem "doppler-env"
+```
+
+## Configuration
+
+### Rails
+
+For Rails applications, all you need to do is require `doppler-env` in your `config/environments/development.rb` file:
+
+```
+require "doppler-env/load"
+```
+
+Make sure it's the first require in that file.
+
+### General
+
+First, require `doppler-env` in your project. Make sure it's required and loaded before any other libraries. To do this you can require the library and manually call `Doppler.load`:
+
+```ruby
+# will cause your Doppler secrets to get injected into ENV for your application,
+# but will not override any pre-existing ENV variables.
+require "doppler-env"
+DopplerEnv.load
+```
+
+or
+
+```ruby
+require "doppler-env/load"
+```
+
+You can also force it to override pre-existing ENV variables with:
+
+```ruby
+require "doppler-env"
+DopplerEnv.load!
+```
+
+After you have the library loading in your application, you need to configure which secrets to fetch for your application by either using the CLI in the root directory of your application:
+
+```sh
+doppler setup
+```
+
+or by setting the `DOPPLER_PROJECT` and `DOPPLER_CONFIG` environment variables in your debug configuration within RubyMine or Visual Studio Code.
+
+Now whenever the Ruby interpreter is invoked for your application, secrets will be injected prior to your application being run:
+
+```sh
+ruby app.rb
+
+[doppler-env]: DOPPLER_ENV environment variable set. Fetching secrets using Doppler CLI.
+[doppler-env]: Secrets loaded successfully:
+[doppler-env]:   {"DOPPLER_CONFIG"=>"dev", "DOPPLER_ENVIRONMENT"=>"dev", "DOPPLER_PROJECT"=>"example"}
+```
+
+In restrictive environments where the use of the Doppler CLI isn't possible, set a `DOPPLER_TOKEN` environment variable with a [Service Token](https://docs.doppler.com/docs/service-tokens) to fetch secrets directly from the Doppler API:
+
+
+```sh
+ruby app.rb
+
+[doppler-env]: DOPPLER_TOKEN environment variable set. Fetching secrets from Doppler API.
+[doppler-env]: Secrets loaded successfully:
+[doppler-env]:   {"DOPPLER_CONFIG"=>"dev", "DOPPLER_ENVIRONMENT"=>"dev", "DOPPLER_PROJECT"=>"example"}
+```
+
+## Acknowledgements
+
+This approach to injecting environment variables was inspired by [dotenv](https://github.com/bkeepers/dotenv).
+
+## Issues
+
+For any bug reports, issues, or enhancements, please [create a repository issue](https://github.com/DopplerHQ/ruby-doppler-env/issues/new).
+
+# Support
+
+You can get support in the [Doppler community forum](https://community.doppler.com/), find us on [Twitter](https://twitter.com/doppler), and for bugs or feature requests, [create an issue](https://github.com/DopplerHQ/ruby-doppler-env/issues/new) on the [DopplerHQ/ruby-doppler-env](https://github.com/DopplerHQ/ruby-doppler-env) GitHub repository.
+
+If you need help, either use our in-product support or head over to the [Doppler Community Forum](https://community.doppler.com/) to get your questions answered by a member of the Doppler support team or 

data/lib/doppler-env/load.rb

@@ -0,0 +1,2 @@
+require "doppler-env"
+DopplerEnv.load

data/lib/doppler-env/version.rb

@@ -0,0 +1,3 @@
+module DopplerEnv
+  VERSION = "0.1.0".freeze
+end

data/lib/doppler-env.rb

@@ -0,0 +1,124 @@
+require "net/http"
+require "json"
+require "open3"
+
+module DopplerEnv
+  DOPPLER_TOKEN = ENV["DOPPLER_TOKEN"]
+  DOPPLER_PROJECT = ENV["DOPPLER_PROJECT"]
+  DOPPLER_CONFIG = ENV["DOPPLER_CONFIG"]
+  DOPPLER_URL = URI("https://api.doppler.com/v3/configs/config/secrets/download")
+
+  # get path to Ruby binary being used for debug purposes
+  RUBY = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name']).sub(/.*\s.*/m, '"\&"')
+
+  module_function
+
+  def log(message)
+    puts "[doppler-env]: #{message}"
+  end
+
+  def log_debug
+    log "[DEBUG] Token: #{DOPPLER_TOKEN && DOPPLER_TOKEN.to_s.split(".")[0...-1].push("*****").join(".").inspect || DOPPLER_TOKEN.inspect}"
+    log "[DEBUG] Project: #{DOPPLER_PROJECT.inspect}"
+    log "[DEBUG] Config: #{DOPPLER_CONFIG.inspect}"
+    log "[DEBUG] Ruby path: #{RUBY}"
+    log "[DEBUG] Working directory: #{Dir.getwd}"
+  end
+
+  # loads secrets into ENV so long as the variable doesn't already exist
+  def load_secrets(secrets)
+    secrets.each do |k,v|
+      ENV[k] ||= v
+    end
+    log "Secrets loaded successfully:"
+    log "  project=#{ENV["DOPPLER_PROJECT"]} config=#{ENV["DOPPLER_CONFIG"]} environment=#{ENV["DOPPLER_ENVIRONMENT"]}"
+  end
+
+  # loads secrets into ENV, overwriting any variables that already exist
+  def load_secrets!(secrets)
+    secrets.each do |k,v|
+      ENV[k] = v
+    end
+    log "Secrets loaded successfully:"
+    log "  project=#{ENV["DOPPLER_PROJECT"]} config=#{ENV["DOPPLER_CONFIG"]} environment=#{ENV["DOPPLER_ENVIRONMENT"]}"
+  end
+
+  # this method expects `doppler setup` to have already been run
+  def fetch_secrets_cli
+    command = "doppler secrets download --no-file".split(" ")
+
+    begin
+      stdout, stderr, status = Open3.capture3(*command)
+    rescue Errno::ENOENT
+      log "No secrets loaded. The Doppler CLI is not installed. See https://docs.doppler.com/docs/install-cli."
+      log_debug
+      return
+    end
+
+    if status.success?
+      JSON.parse(stdout)
+    else
+      log "Error: No secrets loaded. CLI failed to load secrets. Please make sure `doppler setup` has been run."
+      log_debug
+      return
+    end
+  end
+
+  # if using a service token, the project and config are inferred. if using a
+  # personal or CLI token you need to supply a project and config.
+  def fetch_secrets_api
+    unless DOPPLER_PROJECT && DOPPLER_CONFIG || DOPPLER_TOKEN.start_with?("dp.st")
+      log "Error: No secrets loaded. DOPPLER_PROJECT and DOPPLER_CONFIG environment variables must be set if using a CLI or Personal Token."
+      log_debug
+      return
+    end
+    params = { project: DOPPLER_PROJECT, config: DOPPLER_CONFIG, format: "json" }
+    DOPPLER_URL.query = URI.encode_www_form(params)
+
+    req = Net::HTTP::Get.new(DOPPLER_URL)
+    req.basic_auth DOPPLER_TOKEN, ""
+
+    res = Net::HTTP.start(DOPPLER_URL.hostname, DOPPLER_URL.port, use_ssl: true) do |http|
+      http.request(req)
+    end
+
+    case res
+    when Net::HTTPSuccess
+      return JSON.parse(res.body)
+    when Net::HTTPUnauthorized
+      log "Unauthorized: No secrets loaded. Please make sure you're using a valid Doppler token."
+      log_debug
+    else
+      log res.inspect
+      log "Error: No secrets loaded. A failure occurred while attempting to load secrets."
+      log_debug
+    end
+  end
+
+  def load(override = false)
+    # if `DOPPLER_TOKEN` is set, we use the API. if that isn't set, we use the
+    # CLI and expect `doppler setup` to have been run already.
+    if DOPPLER_TOKEN
+      log "DOPPLER_TOKEN environment variable set. Fetching secrets from Doppler API."
+      secrets = fetch_secrets_api
+    else
+      log "Fetching secrets using Doppler CLI."
+      secrets = fetch_secrets_cli
+    end
+  
+    if secrets
+      # if `override` is true, we will override any existing env
+      # variables that existed with new ones coming in from Doppler. otherwise,
+      # pre-existing variables are left untouched.
+      if override
+        load_secrets!(secrets)
+      else
+        load_secrets(secrets)
+      end
+    end
+  end
+
+  def load!
+    load(true)
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: doppler-env
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Doppler Team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-04 00:00:00.000000000 Z
+dependencies: []
+description: Autoload secrets from Doppler.
+email:
+- bot@doppler.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/doppler-env.rb
+- lib/doppler-env/load.rb
+- lib/doppler-env/version.rb
+homepage: https://github.com/dopplerhq/ruby-doppler-env
+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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Autoload secrets from Doppler.
+test_files: []