neon_secrets 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df260eeb955f5de70d0527f19139de2a63f1719531cbd7108fca78759a145e79
+  data.tar.gz: 1161dd945b93c5a58aef3acf26bd39a51b5ad58b378773bbfcb55a8b787ac56d
+SHA512:
+  metadata.gz: c0cfef9dc53275dd8445030905c2eea8d802517a8523486d8c1ffd43ced4107c23c0ad64e690ce2cfc8e7a2c4b174600f2f73d19281c015f984844ec037c509d
+  data.tar.gz: 180cd5558f3c3ce0652bbf2fbef4adb601e332dfd81ccd6e9bbe661bf72e838e6ab15304ad85363259fb36e95dfe97a4da40a91d41eb35222f9cc9082f5b9266

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.7

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in neon_postgres.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "standard"
+
+gem "pry", "~> 0.14.1"
+
+gem "faker", "~> 2.17"

data/Gemfile.lock

@@ -0,0 +1,147 @@
+PATH
+  remote: .
+  specs:
+    neon_secrets (0.0.1)
+      google-cloud-secret_manager (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    faker (2.17.0)
+      i18n (>= 1.6, < 2)
+    faraday (1.4.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
+    gapic-common (0.5.0)
+      faraday (~> 1.3)
+      google-protobuf (~> 3.14)
+      googleapis-common-protos (>= 1.3.11, < 2.a)
+      googleapis-common-protos-types (>= 1.0.6, < 2.a)
+      googleauth (>= 0.16.2, < 2.a)
+      grpc (~> 1.36)
+    google-cloud-core (1.6.0)
+      google-cloud-env (~> 1.0)
+      google-cloud-errors (~> 1.0)
+    google-cloud-env (1.5.0)
+      faraday (>= 0.17.3, < 2.0)
+    google-cloud-errors (1.1.0)
+    google-cloud-secret_manager (1.1.0)
+      google-cloud-core (~> 1.5)
+      google-cloud-secret_manager-v1 (~> 0.1)
+      google-cloud-secret_manager-v1beta1 (~> 0.3)
+    google-cloud-secret_manager-v1 (0.10.0)
+      gapic-common (~> 0.4)
+      google-cloud-errors (~> 1.0)
+      grpc-google-iam-v1 (>= 0.6.10, < 2.0)
+    google-cloud-secret_manager-v1beta1 (0.8.0)
+      gapic-common (~> 0.3)
+      google-cloud-errors (~> 1.0)
+      grpc-google-iam-v1 (>= 0.6.10, < 2.0)
+    google-protobuf (3.17.3)
+    googleapis-common-protos (1.3.11)
+      google-protobuf (~> 3.14)
+      googleapis-common-protos-types (>= 1.0.6, < 2.0)
+      grpc (~> 1.27)
+    googleapis-common-protos-types (1.0.6)
+      google-protobuf (~> 3.14)
+    googleauth (0.16.2)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.14)
+    grpc (1.38.0)
+      google-protobuf (~> 3.15)
+      googleapis-common-protos-types (~> 1.0)
+    grpc-google-iam-v1 (0.6.11)
+      google-protobuf (~> 3.14)
+      googleapis-common-protos (>= 1.3.11, < 2.0)
+      grpc (~> 1.27)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    jwt (2.2.3)
+    memoist (0.16.2)
+    method_source (1.0.0)
+    multi_json (1.15.0)
+    multipart-post (2.1.1)
+    os (1.1.1)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.12.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.10.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
+    signet (0.15.0)
+      addressable (~> 2.3)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    standard (1.0.5)
+      rubocop (= 1.12.1)
+      rubocop-performance (= 1.10.1)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faker (~> 2.17)
+  neon_secrets!
+  pry (~> 0.14.1)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  standard
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,33 @@
+# Neon Secrets
+
+This gem is used by other gems to manage environment variables, either locally
+with Doppler, or in our GCP environments with GCP Secrets Manager.
+
+## Interface
+
+This gem exposes one class, `NeonSecrets::Getter`, with one method, `.get`. In
+your code you can call it like:
+
+```ruby
+import 'neon_secrets'
+
+NeonSecrets::Getter.get(secret_name: "postgres_url")
+NeonSecrets::Getter.get(secret_name: "stripe_api_key")
+```
+
+Secrets are set in Doppler by Neon Law administrators.
+
+## The NEON_ENV environment variable
+
+This gem works based on the value of `NEON_ENV`, which should either be
+`development`, `staging`, or `production`. If this is not set,
+`NeonSecrets::Getter.get` will throw an error.
+
+If the `NEON_ENV` is `staging` or `production`, you will also need the
+`NEON_PROJECT` set so that this library can find the proper GCP Secret
+containing the environment variables.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/neonlaw/codebase.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/neon_secrets.rb

@@ -0,0 +1,41 @@
+require "neon_secrets/version"
+require "google/cloud/secret_manager"
+
+module NeonSecrets
+  class Error < StandardError; end
+
+  class Getter
+    def self.get(secret_name:, gcp_secret_name: nil)
+      new(
+        secret_name: secret_name,
+        gcp_secret_name: gcp_secret_name
+      ).secret_value
+    end
+
+    def initialize(secret_name:, gcp_secret_name:)
+      @secret_name = secret_name.upcase
+      @gcp_secret_name = gcp_secret_name
+    end
+
+    def secret_value
+      if neon_env == "development"
+        ENV.fetch(secret_name)
+      else
+        client = Google::Cloud::SecretManager.secret_manager_service
+        secret_name = "#{gcp_secret_name}.latest"
+
+        secrets = client.access_secret_version name: secret_name
+
+        JSON.parse(secrets).fetch(secret_name)
+      end
+    end
+
+    attr_reader :secret_name, :gcp_secret_name
+
+    private
+
+    def neon_env
+      @_neon_env ||= ENV.fetch("NEON_ENV") { "development" }
+    end
+  end
+end

data/lib/neon_secrets/version.rb

@@ -0,0 +1,3 @@
+module NeonSecrets
+  VERSION = "0.0.1"
+end

data/neon_secrets.gemspec

@@ -0,0 +1,26 @@
+require_relative "lib/neon_secrets/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "neon_secrets"
+  spec.version = NeonSecrets::VERSION
+  spec.authors = ["Neon Law"]
+  spec.email = ["support@neonlaw.com"]
+
+  spec.summary = "A gem to handle secrets in the Neon Law software space."
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/neonlaw/codebase"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "google-cloud-secret_manager", "~> 1.1"
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: neon_secrets
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Neon Law
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-secret_manager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: A gem to handle secrets in the Neon Law software space.
+email:
+- support@neonlaw.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/neon_secrets.rb
+- lib/neon_secrets/version.rb
+- neon_secrets.gemspec
+homepage: https://github.com/neonlaw/codebase
+licenses: []
+metadata:
+  homepage_uri: https://github.com/neonlaw/codebase
+  source_code_uri: https://github.com/neonlaw/codebase
+  changelog_uri: https://github.com/neonlaw/codebase
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: A gem to handle secrets in the Neon Law software space.
+test_files: []