rails_db_guard 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f8a0fc06916b9f01df67d54964524c7e26249314386df6647c679c491ac1dff
+  data.tar.gz: 65bb14cc692568e0596b7d6680ae1a61d4989238524923b00e7cbe480cea4488
+SHA512:
+  metadata.gz: 40862f3e2c43ff178170f08a5442395bc05ad85e20f9bf5bb5ab8de02cae48ca9c7d14fb46dbec4f1dc7474ed0f629443b0269fd832d6479a94f396c4fb6ad30
+  data.tar.gz: d1bdd8d0f397a96d90936d7eead125e3f64b5fa1efa72f53676d2b386c2a784ff47fd3dc81ca5fab3fdff6601dedc570694dae02d7146b1baa0f0839cd73caf5

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.DS_Store
+*.sqlite3
+*.log
+tmp
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at vladocingel@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rails_db_guard.gemspec
+gemspec
+
+gem "rails", "5.2.3"
+gem "sqlite3"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Vlado Cingel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# RailsDbGuard
+
+Prevents connecting to protected environments databases from other environments.
+
+Have you ever used `DATABASE_URL` from production in development? If yes, this is a gem for you. If not, some of your colleague has (or will), so this is a gem for you :)
+
+It is super easy to forget and keep using production database locally and make a disaster. RailsDbGuard is here to protect you!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails_db_guard", group: [:development, :test]
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_db_guard
+
+## Usage
+
+Just add `rails_db_guard` to your Gemfile and you are done. You don't need it in production so you can put it to all other groups.  It will raise and error if you try to connect to protected environment database from other environment.
+
+By default `production` is only protected environment so if you have other sensitive environments (staging for example) it would be like:
+
+```ruby
+# Gemfile
+group :staging, :development, :test do
+  gem "rails_db_guard"
+end
+```
+
+```ruby
+# config/application.rb
+config.active_record.protected_environments = %w[production staging]
+```
+
+## How it works
+
+Rails 5 [added a feature](https://github.com/rails/rails/pull/22967) that prevents destructive actions on production database. New database table `ar_internal_metadata` was added that will store environment name when you run `db:migrate` for the first time.
+Now every time you run destructive rake task Rails will raise an exception preventing the data loss. It works by comparing Rails environment with the environment value in the `ar_internal_metadata` table.
+
+But it will do nothing if you run "destructive" action from your app (console, test, ...). This is where RailsDbGuard comes into play. It will add a callback whenever database connection is established and raise an exception preventing you from accessing protected environment from other environments (You can access production database only from production Rails environment).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+### Running tests
+
+Testing is a bit specific cause we need to test callback on database connection establishing and that is done for test database during test suite boot.
+Easiest solution we could think of is to remove connection before each test and then manually connect in each test to desired database.
+This also mean you will need to prepare database for each environment.
+
+    $ cd test/rails_app # to dummy rails app for testing
+    $ RAILS_ENV=test bundle exec rake db:migrate
+    $ RAILS_ENV=development bundle exec rake db:migrate
+    $ RAILS_ENV=production bundle exec rake db:migrate
+    $ cd ../.. # to gem root
+    $ bundle exec rake test
+
+## ToDo
+
+* MySQL adapter
+* CI setup (matrix for multiple database adapter and rails versions combinations)
+* Setup Rubocop
+* Add option to skip the check if `DISABLE_DATABASE_ENVIRONMENT_CHECK` environment variable is set
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/betterdoc-org/rails_db_guard. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RailsDbGuard project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rails_db_guard/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_db_guard"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rails_db_guard.rb

@@ -0,0 +1,24 @@
+require "rails_db_guard/version"
+
+module RailsDbGuard
+  class Error < StandardError; end
+
+  ENV_NAME_SQL = "SELECT value FROM ar_internal_metadata WHERE key = 'environment'"
+
+  class << self
+    def call
+      ActiveSupport.on_load(:active_record) do
+        adapter = ActiveRecord::Base.configurations[Rails.env]["adapter"]
+        require "rails_db_guard/adapters/#{adapter}"
+      end
+    end
+
+    def guard!(env)
+      return unless (ActiveRecord::Base.protected_environments.include?(env) && Rails.env != env)
+
+      raise Error, "You are trying to connect to `#{env}` database from `#{Rails.env}` environment"
+    end
+  end
+end
+
+require "rails_db_guard/railtie"

data/lib/rails_db_guard/adapters/postgresql.rb

@@ -0,0 +1,8 @@
+ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.set_callback :checkout, :after do
+  begin
+    env = raw_connection.exec(RailsDbGuard::ENV_NAME_SQL).values.flatten.first
+    RailsDbGuard.guard!(env)
+  rescue PG::UndefinedTable => e
+    raise e unless e.message =~ /relation \"ar_internal_metadata\" does not exist/
+  end
+end

data/lib/rails_db_guard/adapters/sqlite3.rb

@@ -0,0 +1,8 @@
+ActiveRecord::ConnectionAdapters::SQLite3Adapter.set_callback :checkout, :after do
+  begin
+    env = raw_connection.execute(RailsDbGuard::ENV_NAME_SQL).first["value"]
+    RailsDbGuard.guard!(env)
+  rescue SQLite3::SQLException => e
+    raise e unless e.message =~ /no such table\: ar_internal_metadata/
+  end
+end

data/lib/rails_db_guard/railtie.rb

@@ -0,0 +1,5 @@
+class RailsDbGuard::Railtie < Rails::Railtie
+  config.to_prepare do
+    RailsDbGuard.call
+  end
+end

data/lib/rails_db_guard/version.rb

@@ -0,0 +1,3 @@
+module RailsDbGuard
+  VERSION = "1.0.1"
+end

data/rails_db_guard.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails_db_guard/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_db_guard"
+  spec.version       = RailsDbGuard::VERSION
+  spec.authors       = ["BetterDoc GmbH"]
+  spec.email         = ["pirates@betterdoc.org"]
+
+  spec.summary       = %q{Prevents connecting to protected environments databases from other environments}
+  spec.homepage      = "https://github.com/betterdoc-org/rails_db_guard"
+  spec.license       = "MIT"
+
+  # 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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 5"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "minitest", "~> 5"
+  spec.add_development_dependency "rake", "~> 10"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: rails_db_guard
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- BetterDoc GmbH
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+description: 
+email:
+- pirates@betterdoc.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_db_guard.rb
+- lib/rails_db_guard/adapters/postgresql.rb
+- lib/rails_db_guard/adapters/sqlite3.rb
+- lib/rails_db_guard/railtie.rb
+- lib/rails_db_guard/version.rb
+- rails_db_guard.gemspec
+homepage: https://github.com/betterdoc-org/rails_db_guard
+licenses:
+- MIT
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Prevents connecting to protected environments databases from other environments
+test_files: []